Title: | Plantilla 'pkgdown' para los paquetes de 'rOpenSpain' |
---|---|
Description: | Plantilla privada para uso exclusivo de los paquetes de rOpenSpain. |
Authors: | Diego Hernangómez [aut, cre, cph] (<https://orcid.org/0000-0001-8457-4658>, rOpenSpain) |
Maintainer: | Diego Hernangómez <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.2.0.9000 |
Built: | 2024-08-09 22:19:50 UTC |
Source: | https://github.com/rOpenSpain/rostemplate |
La acción GitHub creada ejecuta R CMD check
para tu paquete.
La configuración por defecto ejecuta el check de manera mensual los dias 1
de mes a las 08:30 AM.
ros_actions_check_cron(pkg = ".", overwrite = TRUE)
ros_actions_check_cron(pkg = ".", overwrite = TRUE)
pkg |
Ruta a la raíz del paquete. |
overwrite |
Sobreescribe la acción si ya se encuntra instalada. |
Puedes aprender cómo configurar la acción cron en el siguiente link: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#schedule.
La configuración por defecto '30 08 1 * *'
("A las 08:30 del
dia-del-mes 1.").
Usa crontab.guru para crear tus propia configuración cron.
gh-pages
Instala una acción GitHub que crea el sitio pkgdown de tu paquete
en la rama gh-pages
de tu repositorio.
ros_actions_pkgdown_branch(pkg = ".", overwrite = TRUE)
ros_actions_pkgdown_branch(pkg = ".", overwrite = TRUE)
pkg |
Ruta a la raíz del paquete. |
overwrite |
Sobreescribe la acción si ya se encuntra instalada. |
ros_build()
, ros_actions_pkgdown_docs()
/docs
Esta acción GitHub genera tu sitio pkgdown en la carpeta docs
de tu repositorio.
ros_actions_pkgdown_docs(pkg = ".", overwrite = TRUE)
ros_actions_pkgdown_docs(pkg = ".", overwrite = TRUE)
pkg |
Ruta a la raíz del paquete. |
overwrite |
Sobreescribe la acción si ya se encuntra instalada. |
El resultado final es equivalente a ejecutar ros_build()
con la única
diferencia de que este comando se ejecuta en GitHub, en lugar de tener que
ser ejecutado por el usuario.
ros_build()
, ros_actions_pkgdown_branch()
.
README
Añade una insignia de rOpenSpain que redirige a https://ropenspain.es/
en tu archivo README
:
ros_badge_ropenspain(install = TRUE)
ros_badge_ropenspain(install = TRUE)
install |
TRUE/FALSE. Si es |
Insignia en markdown o mensaje con el código markdown a introducir.
ros_badge_ropenspain(install = FALSE)
ros_badge_ropenspain(install = FALSE)
Esta función es un wrapper de pkgdown::build_site()
.
ros_build(pkg = ".", ...)
ros_build(pkg = ".", ...)
pkg |
Path to package. |
... |
Arguments passed on to
|
La única diferencia con pkgdown::build_site()
es que te recuerda los pasos
a seguir para configurar rostemplate
, y pide confirmación antes de
ejecutar pkgdown::build_site()
. El resultado se genera en la carpeta
/docs
.
Al contrario que ros_actions_pkgdown_branch()
, esta acción se ejecuta por
el usuario.
ros_actions_pkgdown_branch()
, pkgdown::build_site()
.
Paletas de colores basadas en el tema de rOpenSpain.
ros_green_pal(n = 4, alpha = 0.9, rev = FALSE) ros_violet_pal(n = 4, alpha = 0.9, rev = FALSE) ros_gradient_pal(n = 4, alpha = 0.9, rev = FALSE) ros_qualitative_pal(n = 6, alpha = 0.9, rev = FALSE) ros_metro_madrid_pal(n = 4, alpha = 0.9, rev = FALSE)
ros_green_pal(n = 4, alpha = 0.9, rev = FALSE) ros_violet_pal(n = 4, alpha = 0.9, rev = FALSE) ros_gradient_pal(n = 4, alpha = 0.9, rev = FALSE) ros_qualitative_pal(n = 6, alpha = 0.9, rev = FALSE) ros_metro_madrid_pal(n = 4, alpha = 0.9, rev = FALSE)
n |
Número de colores |
alpha |
Valor alfa (transparencia) de los colores. alpha = 1 es opaco y alpha = 0 totalmente transparente |
rev |
Valor lógico que indica si los colores se han de mostar en orden inverso. |
Paletas de colores
scales::show_col(ros_green_pal(9)) scales::show_col(ros_violet_pal(9)) scales::show_col(ros_gradient_pal(9)) scales::show_col(ros_qualitative_pal(9)) scales::show_col(ros_metro_madrid_pal(9))
scales::show_col(ros_green_pal(9)) scales::show_col(ros_violet_pal(9)) scales::show_col(ros_gradient_pal(9)) scales::show_col(ros_qualitative_pal(9)) scales::show_col(ros_metro_madrid_pal(9))