Title: Easy DataOps for R Users
Version: 0.2.2
Description: Create and view tickets in 'gitea', a self-hosted git service https://gitea.io, using an 'RStudio' addin, and use helper functions to publish documentation and use git.
License: AGPL (≥ 3)
Depends: R (≥ 3.4)
Imports: dplyr (≥ 0.8.1), gitear (≥ 0.0.2), kableExtra (≥ 1.1.0), lubridate (≥ 1.7.4), miniUI (≥ 0.1.1.1), RColorBrewer (≥ 1.1.2), shiny.i18n (≥ 0.2.0), shiny (≥ 1.3.2), stringr (≥ 1.4.0), shinyWidgets (≥ 0.2.1), purrr (≥ 0.3.4), gert (≥ 1.5.0), keyring (≥ 1.3.0), methods
Suggests: knitr (≥ 1.23), git2r (≥ 0.30.1), here (≥ 1.0.1), tibble (≥ 3.1.6), readr (≥ 1.3.1), rmarkdown (≥ 1.12), rstudioapi (≥ 0.10), testthat (≥ 3.0.0), tidyr (≥ 0.8.3),
VignetteBuilder: knitr
Encoding: UTF-8
RoxygenNote: 7.2.0
URL: https://github.com/ixpantia/ixplorer
BugReports: https://github.com/ixpantia/ixplorer/issues
Config/testthat/edition: 3
NeedsCompilation: no
Packaged: 2022-07-01 19:54:01 UTC; frans
Author: ixpantia, SRL [cph], Frans van Dunne ORCID iD [cre, aut], Ronny Hernández Mora ORCID iD [aut], Daniel Granados Campos [ctb], Nayib Vargas Zuñiga [ctb]
Maintainer: Frans van Dunne <frans@ixpantia.com>
Repository: CRAN
Date/Publication: 2022-07-02 10:20:02 UTC

Actualice la rama master desde el upstream

Description

actualiza su rama master con su upstream por medio de git rebase

Usage

actualizar_rama()

Value

No hay valor de retorno - se llama por su efecto secundario

Authentication in ixplorer

Description

Saves to your computer through the authentication system of your computer's OS.

Usage

add_token()

Details

Currently needs to be done everytime a new session is started. In case the credentials already exist, just enter the url and confirm if you want to keep the credentials on your computer or want to delete them after the next query.

Value

No return value, called for side effects

Add the upstream to the repository that is active in RStudio.

Description

Add the upstream to the repository that is active in RStudio at the moment

Usage

add_upstream(instance = "saved")

Arguments

instance

ixplorer instance (Eg: "secure", "masterclass", "prueba")

Value

No return value, called for side effects

Crear tiquete

Description

Cree tiquetes (título y cuerpo) desde el add-in de ixplorer sin perder las ideas durante su flujo de trabajo

Usage

crear_tiquetes(instancia = "guardada")

Arguments

instancia

instancia de ixplorer (Ejemplo: "secure", "masterclass", "prueba")

Value

No hay valor de retorno - se llama por su efecto secundario

Create ticket

Description

Create tickets (title and body) from the ixplorer addin without losing ideas during your workflow.

Usage

create_tickets(instance = "saved")

Arguments

instance

ixplorer instance (Eg: "secure", "masterclass", "prueba")

Value

No return value, called for side effects

Current tickets

Description

View tickets for a specific user on a computer and get links to your ixplorer based on the credentials used in the authentication gadget.

Usage

current_tickets(instance = "saved")

Arguments

instance

ixplorer instance (Eg: "secure", "masterclass", "prueba")

Value

No return value, called for side effects

Show ixplorer dashboard

Description

Show ixplorer dashboard

Usage

dashboard()

Value

No return value, called for side effects

Delete your ixplorer credentials

Description

Delete your ixplorer credentials

Usage

delete_credentials(instance = "current")

Arguments

instance

an instance from ixplorer such as "prueba" or "masterclass"

Details

Delete the credentials saved by add_token() in your computer. This can be useful when you are using the ixplorer package on a shared computer or any other case you don't want to keep the credentials stored

Value

Delete credentials saved by add_token()

Examples

## Not run: 
delete_credentials("masterclass")

## End(Not run)

Elimina tus credenciales de ixplorer

Description

Elimina tus credenciales de ixplorer

Usage

eliminar_credenciales(instancia = "actual")

Arguments

instancia

una instancia de ixplorer como "masterclass" o "prueba"

Details

Borre las credenciales guardadas por add_token() en su computadora. Esto puede ser útil cuando está usando el paquete ixplorer en una computadora compartida o en cualquier otro caso en el que no desee mantener las credenciales almacenadas.

Value

Elimina las credenciales guardadas por add_token()

Examples

## Not run: 
delete_credentials("masterclass")

## End(Not run)

Extienda el tiempo de sus credenciales de git

Description

Esta es una función traducida que llama a set_git_timeout. Establezca la cantidad de segundos para que se agote el tiempo de espera del caché de credenciales de git. Tenga en cuenta que esto está escrito para trabajar en servidores remotos donde no queremos almacenar nuestras credenciales de git (otros pueden tener acceso o hacerse pasar por nosotros). En una máquina confiable, la configuración más común sería (en una máquina Linux) git credential.helper store. Sin embargo, se requiere algo de almacenamiento en caché cuando se trabaja en un servidor remoto porque los ciclos frecuentes de envío y confirmación en los que tiene que escribir su nombre de usuario y contraseña cada vez no son agradables.

De forma predeterminada, esto solo se aplicará al repositorio en el que está trabajando. Si llama a la versión global, asegúrese de que esto es lo que desea. También por defecto, el tiempo de espera se establece en 4 horas (14400 segundos).

Usage

fijar_tiempo_credenciales(pausa = 14400, global = FALSE)

Arguments

pausa

número de segundos antes del tiempo de espera

global

si el cambio debe ser global o local para el repositorio

Value

No hay valor de retorno - se llama por su efecto secundario

Get the active instance in the session

Description

By default, functions that get tickets and pull requests use the active instance in the session. This functions gets this active instance.

Usage

get_instance()

Value

a character of the active issue in the session

Title Agregue el upstream al repositorio que está activo en RStudio.

Description

Title Agregue el upstream al repositorio que está activo en RStudio.

Usage

incluye_upstream(instancia = "guardada")

Arguments

instancia

instancia de ixplorer (Ej: "secure", "masterclass", "prueba")

Details

Esta función es la versión en español de add_upstream(). Perminte agregar el upstream al repositorio que está activo en RStudio en este momento

Value

No hay valor de retorno - se llama por su efecto secundario

ixplorer package ixplorer.es package ixplorer package

Description

ixplorer for dataops

Details

See the README on

List closed tickets

Description

List of closed tickets from the indicated repository.

Usage

list_closed_tickets(instance = "saved", lag = NULL)

Arguments

instance

instance from ixplorer (Ejm: "secure", "masterclass", "prueba") ixplorer

lag

is the time in days that you want to look back. For example if you want to see the issues closed in the last 7 days, lag = 7. By default it shows all the issues without any lag..

Value

No return value, called for side effects

List open pull requests

Description

Lists your open pull requests in ixplorer

Usage

list_open_pr(instance = "all", assignee = "team")

Arguments

instance

an instance from ixplorer such as "masterclass" or "prueba". Default value "all" lists the pull requests of all your saved instances. Value "saved" lists pull requests from your current instance

assignee

name of a person from your team. Default "team" lists all the pull requests in the instance with all assignees. When the value is "me" it filters the pull requests list for assigned to you according to your username provided in add_token()

Value

tibble of list instances

Examples

## Not run: 
list_open_pr(instance = "prueba",
             assignee = "daniel")

## End(Not run)

List open tickets

Description

List of open tickets in the repository

Usage

list_open_tickets(instance = "saved", lag = NULL)

Arguments

instance

instance from ixplorer (E.g. "secure", "masterclass", "prueba")

lag

is the time in days that you want to look back. For example if you want to see the tickets closed in the last 7 days, lag = 7. By default it shows all the tickets without any lag..

Value

No return value, called for side effects

Lista de tiquetes abiertos

Description

Listado de tiquetes abiertos del repositorio indicado.

Usage

listar_tiquetes_abiertos(instancia = "guardada", dias = NULL)

Arguments

instancia

instancia de ixplorer (Ejm: "secure", "masterclass", "prueba")

dias

es el tiempo en días que se quiere ver hacia atrás. Por ejemplo si se quiere ver los tiquetes creados en los últimos 7 días, lag = 7. Por defecto muestra todos los tiquetes sin ningún lag.

Value

No hay valor de retorno - se llama por su efecto secundario

Lista de tiquetes cerrados

Description

Listado de tiquetes cerrados del repositorio indicado.

Usage

listar_tiquetes_cerrados(instancia = "guardada", dias = NULL)

Arguments

instancia

instancia de ixplorer (Ejm: "secure", "masterclass", "prueba")

dias

es el tiempo en días que se quiere ver hacia atrás. Por ejemplo si se quiere ver los tiquetes cerrados en los últimos 7 días, lag = 7. Por defecto muestra todos los tiquetes sin ningún lag.

Value

No hay valor de retorno - se llama por su efecto secundario

Publica en el wiki repo

Description

Publique un rmarkdown específico en el repositorio wiki, especificando la ruta del repositorio wiki una vez que ya haya clonado este repositorio en su máquina. Consulte Detalles si es la primera vez que publica en un repositorio wiki.

Usage

publica_wiki(
  rmarkdown = rmarkdown,
  ruta_repo_wiki = path_wiki_repo,
  auto_actualizar = TRUE,
  silenciar_bitacora = FALSE
)

Arguments

rmarkdown

la ruta al archivo rmarkdown

ruta_repo_wiki

la ruta completa al repositorio wiki.

auto_actualizar

Si desea hacer automáticamente el pull, commit y push establecido en TRUE, si desea hacerlo manualmente, establezca FALSE. El valor predeterminado es TRUE.

silenciar_bitacora

Si desea ver la bitacora de renderización establezca TRUE, de lo contrario establezca FALSE. El valor default es TRUE

Details

Publica un rmarkdown en un wiki repo

Si es la primera vez que va a publicar en una wiki, se deben seguir estos pasos:

1.El repositorio wiki debe clonarse en una carpeta de trabajo local. Para hacer esto, primero vaya a la pestaña wiki de su repositorio y deberá crear manualmente la primera página wiki. Si no lo hace, le dirá que el repositorio no existe.

  1. Una vez que haya creado la página de inicio de la wiki, deberá clonar el repositorio de la wiki como lo haría con cualquier otro repositorio en su computadora (usando el enlace que está disponible para usted una vez que haya creado la página de inicio de la wiki).

  2. Una vez que haya clonado la wiki en su computadora, lo que debe indicar en la función publica_wiki es la path_wiki_repo. Esta es la dirección completa en su computadora donde se encuentra este repositorio que clonó. Por ejemplo: ⁠/home/client/project/wiki_repo⁠

Value

Publica un md en un repositorio wiki.

Examples


## Not run: 
publish_wiki(rmarkdown = "eda.Rmd",
             path_wiki_repo = "/home/cliente/proyecto/wiki_repo")

## End(Not run)

Publish into wiki repo

Description

Publish an specific rmarkdown into wiki repository, specifying the path of the wiki repository once that you already clone this repository into your machine. See Details if is your first time publishing in a wiki repository.

Usage

publish_wiki(
  rmarkdown,
  path_wiki_repo,
  automatic_update = FALSE,
  quiet_render_logs = FALSE
)

Arguments

rmarkdown

the path of rmarkdown file

path_wiki_repo

the complete path of wiki repository.

automatic_update

if you like to do automatically the pull, commit and push set in TRUE, if you like to do manually, set FALSE. Default is TRUE.

quiet_render_logs

if you like to see the render logs of rmarkdown, set in TRUE, in otherwise set FALSE. Default is TRUE.

Details

Publish an rmarkdown into wiki repo

If this is the first time you are going to publish in a wiki, you must follow these steps:

  1. The wiki repository must be cloned to a local working folder. To do this first go to the wiki tab of your repository and you will need to manually create the first wiki page. If you don't do this it will tell you that the repository does not exist.

  2. Once you have created the wiki home page, you will need to clone the wiki repository just like you would any other repository on your computer (using the link that is made available to you once you create the wiki home page).

  3. Once you have cloned the wiki on your computer, what you should indicate in the publica_wiki function is the path_wiki_repo. This is the full address on your computer where this repository you cloned is located. For example: ⁠/home/client/project/wiki_repo⁠

Value

Publish a md into wiki repository

Examples


## Not run: 
publish_wiki(rmarkdown = "eda.Rmd",
             path_wiki_repo = "/home/cliente/proyecto/wiki_repo")

## End(Not run)

Set authentication

Description

Set the authentification into ixplorer

Usage

set_authentication(access_data)

Arguments

access_data

Data needed to get into ixplorer

Value

No return value, called for side effects

Set git credential cache time

Description

Set the amount of time that the git credentials will be available on the system you are working on.

Usage

set_git_credentials_cache(hours = 4, global = TRUE)

Arguments

hours

the amount of hours that the credentials should be stored. Defaults to 4 hours.

global

if TRUE then the setting will be sett as a global setting. If FALSE it will only be for the current git repository

Details

As we move between servers to work we oftentimes do not want to store our git passwords there. For instance when we are workign on servers of third parties. The extreme is to include the username and password for every single git call. But with git we can have a middle way where we store the credentials in cache for a limited amount of time.

Value

No return value, called for side effects

Extend git credential cache time-out

Description

Set the number of seconds before the git credential cache times out. Note that this is written for work on remote servers where we do not want to store our git credentials because other might have access to it, or impersonate us. On a trusted machine the most common setting would be (on a linux machine) git credential.helper store. However, some caching is required when working on a remote server because frequent commit-push cycles where you have to write out your username and password every time is not nice.

By default this will only apply to the repo you are working in. If you call the global version take care that this is what you want. Also by default the timeout is set to 4 hours (14400 seconds).

Usage

set_git_timeout(timeout = 14400, global = FALSE)

Arguments

timeout

number of seconds before timeout

global

whether the change should be global or local to the repo

Value

No return value, called for side effects

Synch your master branch with upstream

Description

Runs steps to synch your master branch to upstream automatically

Usage

synch_branch(default_branch_name = "master")

Arguments

default_branch_name

defines a default branch name to be able to synchronize it

Value

No return value, called for side effects

Tiquetes actuales

Description

Vea tiquetes para un usuario específico en una computadora y obtenga enlaces a su ixplorer según las credenciales utilizadas en el gadget de autenticación.

Usage

tiquetes_actuales(instancia = "guardada")

Arguments

instancia

instancia de ixplorer (Ej: "secure", "masterclass", "prueba")

Value

No hay valor de retorno - se llama por su efecto secundario

Verificar autentificacion del ixplorer.

Description

Verifique si hay un archivo .ixplorer en el directorio de trabajo y configure las variables.

Usage

verify_ixplorer_file()

Value

No return value, called for side effects

Verifies ixplorer project

Description

Verifies if the project's name exists in the repository.

Usage

verify_ixproject(gitear_access)

Arguments

gitear_access

parameters to access into an ixplorer instance

Value

No return value, called for side effects

Verifies ixplorer repo

Description

Verifies if ixplorer repository's name exists.

Usage

verify_ixrepo(gitear_access)

Arguments

gitear_access

parameters to access into an ixplorer instance

Value

No return value, called for side effects

Verifies ixplorer user

Description

Verifies token exists for a repository.

Usage

verify_ixtoken(gitear_access)

Arguments

gitear_access

parameters to access into an ixplorer instance

Value

No return value, called for side effects

Verifies ixplorer url

Description

Verifies if the url exists in the repository

Usage

verify_ixurl(gitear_access)

Arguments

gitear_access

parameters to access into an ixplorer instance

Verifies ixplorer user

Description

Verifies if user name exists.

Usage

verify_ixuser(gitear_access)

Arguments

gitear_access

parameters to access into an ixplorer instance

Value

No return value, called for side effects