,
Ronny Hernández Mora [aut] ,
Daniel Granados Campos [ctb],
Nayib Vargas Zuñiga [ctb]| Title: | Easy DataOps for R Users |
|---|---|
| Description: | Create and view tickets in 'gitea', a self-hosted git service <https://about.gitea.com>, using an 'RStudio' addin, and use helper functions to publish documentation and use git. |
| Authors: | ixpantia, SRL [cph],
Frans van Dunne [cre, aut] ,
Ronny Hernández Mora [aut] ,
Daniel Granados Campos [ctb],
Nayib Vargas Zuñiga [ctb] |
| Maintainer: | Frans van Dunne <[email protected]> |
| License: | AGPL (>= 3) |
| Version: | 0.3.4 |
| Built: | 2024-07-01 03:15:32 UTC |
| Source: | https://github.com/ixpantia/ixplorer |
actualiza su rama master con su upstream por medio de git rebase
actualizar_rama(rama_por_defecto)actualizar_rama(rama_por_defecto)
rama_por_defecto |
define la rama por defecto que queremos actualizar |
No hay valor de retorno - se llama por su efecto secundario
Saves to your computer through the authentication system of your computer's OS.
add_token()add_token()
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.
No return value, called for side effects
Add the upstream to the repository that is active in RStudio at the moment
add_upstream(instance = "saved")add_upstream(instance = "saved")
instance |
ixplorer instance (Eg: "secure", "masterclass", "prueba") |
No return value, called for side effects
This function adds a user as a collaborator to a specific repository on ixplorer with specific permissions.
add_user_to_repo( base_url, api_key, owner, repo, username, collaborator_permissions )add_user_to_repo( base_url, api_key, owner, repo, username, collaborator_permissions )
base_url |
The base URL of the ixplorer server. |
api_key |
The API key for authentication on the ixplorer server. |
owner |
The owner (organization or user) of the repository where the user will be added as a collaborator. |
repo |
The name of the repository where the user will be added as a collaborator. |
username |
The username of the user to be added as a collaborator. |
collaborator_permissions |
The permissions to be assigned to the collaborator ("Read", "Write", or "Admin"). |
The response from the ixplorer server.
Cree tiquetes (título y cuerpo) desde el add-in de ixplorer sin perder las ideas durante su flujo de trabajo
crear_tiquetes(instancia = "guardada")crear_tiquetes(instancia = "guardada")
instancia |
instancia de ixplorer (Ejemplo: "secure", "masterclass", "prueba") |
No hay valor de retorno - se llama por su efecto secundario
Create tickets (title and body) from the ixplorer addin without losing ideas during your workflow.
create_tickets(instance = "saved")create_tickets(instance = "saved")
instance |
ixplorer instance (Eg: "secure", "masterclass", "prueba") |
No return value, called for side effects
This function automates the process of creating users and adding them as collaborators to a repository on ixplorer.
create_users( base_url, api_key, owner, repo, user_data_df, collaborator_permissions )create_users( base_url, api_key, owner, repo, user_data_df, collaborator_permissions )
base_url |
The base URL of the ixplorer server. |
api_key |
The API key for authentication on the ixplorer server. |
owner |
The owner (organization or user) of the repository where the users will be added as collaborators. |
repo |
The name of the repository where the users will be added as collaborators. |
user_data_df |
A data frame, each row containing user information (email, login_name, username). |
collaborator_permissions |
The permissions to be assigned to the collaborators ("Read", "Write", or "Admin"). |
A data frame containing information about the created users.
## Not run: # API configuration base_url <- "https://prueba.ixpantia.com" api_key <- "your_api_key" # Replace with your actual API key owner <- "" repo <- "" #User date in a data frame user_data_df <- data.frame( email = c("[email protected]", "[email protected]"), login_name = c("User-1", "User-2"), username = c("User-1", "User-2") ) # Collaborator permissions to be added (Read, Write, or Admin) collaborator_permissions <- "Write" # Create users and add them to the repository with specific permissions results <- create_users(base_url, api_key, owner, repo, user_data_df, collaborator_permissions) ## End(Not run)## Not run: # API configuration base_url <- "https://prueba.ixpantia.com" api_key <- "your_api_key" # Replace with your actual API key owner <- "" repo <- "" #User date in a data frame user_data_df <- data.frame( email = c("[email protected]", "[email protected]"), login_name = c("User-1", "User-2"), username = c("User-1", "User-2") ) # Collaborator permissions to be added (Read, Write, or Admin) collaborator_permissions <- "Write" # Create users and add them to the repository with specific permissions results <- create_users(base_url, api_key, owner, repo, user_data_df, collaborator_permissions) ## End(Not run)
View tickets for a specific user on a computer and get links to your ixplorer based on the credentials used in the authentication gadget.
current_tickets(instance = "saved")current_tickets(instance = "saved")
instance |
ixplorer instance (Eg: "secure", "masterclass", "prueba") |
No return value, called for side effects
Show ixplorer dashboard
dashboard()dashboard()
No return value, called for side effects
Delete your ixplorer credentials
delete_credentials(instance = "current")delete_credentials(instance = "current")
instance |
an instance from ixplorer such as "prueba" or "masterclass" |
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
Delete credentials saved by add_token()
## Not run: delete_credentials("masterclass") ## End(Not run)## Not run: delete_credentials("masterclass") ## End(Not run)
Elimina tus credenciales de ixplorer
eliminar_credenciales(instancia = "actual")eliminar_credenciales(instancia = "actual")
instancia |
una instancia de ixplorer como "masterclass" o "prueba" |
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.
Elimina las credenciales guardadas por add_token()
## Not run: delete_credentials("masterclass") ## End(Not run)## Not run: delete_credentials("masterclass") ## End(Not run)
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 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).
fijar_tiempo_credenciales(pausa = 14400, global = FALSE)fijar_tiempo_credenciales(pausa = 14400, global = FALSE)
pausa |
número de segundos antes del tiempo de espera |
global |
si el cambio debe ser global o local para el repositorio |
No hay valor de retorno - se llama por su efecto secundario
By default, functions that get tickets and pull requests use the active instance in the session. This functions gets this active instance.
get_instance()get_instance()
a character of the active issue in the session
Title Agregue el upstream al repositorio que está activo en RStudio.
incluye_upstream(instancia = "guardada")incluye_upstream(instancia = "guardada")
instancia |
instancia de ixplorer (Ej: "secure", "masterclass", "prueba") |
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
No hay valor de retorno - se llama por su efecto secundario
List of closed tickets from the indicated repository.
list_closed_tickets(instance = "saved", lag = NULL)list_closed_tickets(instance = "saved", lag = NULL)
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.. |
No return value, called for side effects
Lists your open pull requests in ixplorer
list_open_pr(instance = "all", assignee = "team")list_open_pr(instance = "all", assignee = "team")
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() |
tibble of list instances
## Not run: list_open_pr(instance = "prueba", assignee = "daniel") ## End(Not run)## Not run: list_open_pr(instance = "prueba", assignee = "daniel") ## End(Not run)
List of open tickets in the repository
list_open_tickets(instance = "saved", lag = NULL)list_open_tickets(instance = "saved", lag = NULL)
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.. |
No return value, called for side effects
Listado de tiquetes abiertos del repositorio indicado.
listar_tiquetes_abiertos(instancia = "guardada", dias = NULL)listar_tiquetes_abiertos(instancia = "guardada", dias = NULL)
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. |
No hay valor de retorno - se llama por su efecto secundario
Listado de tiquetes cerrados del repositorio indicado.
listar_tiquetes_cerrados(instancia = "guardada", dias = NULL)listar_tiquetes_cerrados(instancia = "guardada", dias = NULL)
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. |
No hay valor de retorno - se llama por su efecto secundario
This function creates a new user on an ixplorer server by sending a POST request to the appropriate endpoint.
new_user(base_url, api_key, owner, repo, user_data)new_user(base_url, api_key, owner, repo, user_data)
base_url |
The base URL of the ixplorer server. |
api_key |
The API key for authentication on the ixplorer server. |
owner |
The owner (organization or user) of the repository where the user will be created. |
repo |
The name of the repository where the user will be created. |
user_data |
An object containing user information, including at least email, login_name, and username. |
A list containing the response from the ixplorer server, including the generated password.
Publique un rmarkdown o qmd 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.
publica_wiki( reporte = report, ruta_repo_wiki = path_wiki_repo, auto_actualizar = TRUE, silenciar_bitacora = FALSE, nuevo_nombre = NULL )publica_wiki( reporte = report, ruta_repo_wiki = path_wiki_repo, auto_actualizar = TRUE, silenciar_bitacora = FALSE, nuevo_nombre = NULL )
reporte |
la ruta al archivo rmarkdown o qmd |
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. |
nuevo_nombre |
el nuevo nombre del archivo markdown. |
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.
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).
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
Publica un md en un repositorio wiki.
## Not run: publish_wiki(reporte = "eda.Rmd", path_wiki_repo = "/home/cliente/proyecto/wiki_repo") ## End(Not run)## Not run: publish_wiki(reporte = "eda.Rmd", path_wiki_repo = "/home/cliente/proyecto/wiki_repo") ## End(Not run)
Publish an specific rmarkdown or qmd 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.
publish_wiki( report, path_wiki_repo, automatic_update = FALSE, new_file_name = NULL, quiet_render_logs = FALSE )publish_wiki( report, path_wiki_repo, automatic_update = FALSE, new_file_name = NULL, quiet_render_logs = FALSE )
report |
the path of rmarkdown or qmd 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. |
new_file_name |
the new name for the markdown file. |
quiet_render_logs |
if you like to see the render logs of rmarkdown, set in TRUE, in otherwise set FALSE. Default is TRUE. |
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:
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.
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).
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
Publish a md into wiki repository.
## Not run: publish_wiki(report = "eda.Rmd", path_wiki_repo = "/home/cliente/proyecto/wiki_repo") ## End(Not run)## Not run: publish_wiki(report = "eda.Rmd", path_wiki_repo = "/home/cliente/proyecto/wiki_repo") ## End(Not run)
Set the authentification into ixplorer
set_authentication(access_data)set_authentication(access_data)
access_data |
Data needed to get into ixplorer |
No return value, called for side effects
Set the amount of time that the git credentials will be available on the system you are working on.
set_git_credentials_cache(hours = 4, global = TRUE)set_git_credentials_cache(hours = 4, global = TRUE)
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 |
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.
No return value, called for side effects
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 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).
set_git_timeout(timeout = 14400, global = FALSE)set_git_timeout(timeout = 14400, global = FALSE)
timeout |
number of seconds before timeout |
global |
whether the change should be global or local to the repo |
No return value, called for side effects
Runs steps to synch your master branch to upstream automatically
synch_branch(default_branch_name = "master")synch_branch(default_branch_name = "master")
default_branch_name |
defines a default branch name to be able to synchronize it |
No return value, called for side effects
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.
tiquetes_actuales(instancia = "guardada")tiquetes_actuales(instancia = "guardada")
instancia |
instancia de ixplorer (Ej: "secure", "masterclass", "prueba") |
No hay valor de retorno - se llama por su efecto secundario
Verifique si hay un archivo .ixplorer en el directorio de trabajo y configure las variables.
verify_ixplorer_file()verify_ixplorer_file()
No return value, called for side effects
Verifies if the project's name exists in the repository.
verify_ixproject(gitear_access)verify_ixproject(gitear_access)
gitear_access |
parameters to access into an ixplorer instance |
No return value, called for side effects
Verifies if ixplorer repository's name exists.
verify_ixrepo(gitear_access)verify_ixrepo(gitear_access)
gitear_access |
parameters to access into an ixplorer instance |
No return value, called for side effects
Verifies token exists for a repository.
verify_ixtoken(gitear_access)verify_ixtoken(gitear_access)
gitear_access |
parameters to access into an ixplorer instance |
No return value, called for side effects
Verifies if the url exists in the repository
verify_ixurl(gitear_access)verify_ixurl(gitear_access)
gitear_access |
parameters to access into an ixplorer instance |
Verifies if user name exists.
verify_ixuser(gitear_access)verify_ixuser(gitear_access)
gitear_access |
parameters to access into an ixplorer instance |
No return value, called for side effects