Package 'rostemplate'

Crea un flujo de trabajo de GitHub Actions para comprobar tu paquete

Description

El flujo de trabajo de GitHub Actions creado ejecuta ⁠R CMD check⁠ para tu paquete. La configuración por defecto ejecuta la comprobación el día 1 de cada mes a las 08:30.

Usage

ros_actions_check_cron(pkg = ".", overwrite = TRUE)

Arguments

pkg	Ruta a la raíz del paquete.
overwrite	Sobrescribe el flujo de trabajo si ya está instalado.

Details

Consulta cómo configurar la ejecución programada en el siguiente enlace:

https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#schedule

La configuración por defecto es "30 08 1 * *" ("a las 08:30 del día 1 de cada mes").

Usa crontab.guru para crear tu propia configuración cron.

Value

Devuelve NULL de forma invisible. Se llama por sus efectos secundarios.

See Also

Flujos de trabajo de GitHub Actions: ros_actions_pkgdown_branch(), ros_actions_pkgdown_docs()

Examples

pkg <- file.path(tempdir(), "pkgdown-cron")
if (!dir.exists(pkg)) {
  dir.create(pkg)
}
ros_actions_check_cron(pkg)

---

Crea un sitio en gh-pages mediante GitHub Actions

Description

Instala un flujo de trabajo de GitHub Actions que genera el sitio pkgdown del paquete en la rama gh-pages del repositorio.

Usage

ros_actions_pkgdown_branch(pkg = ".", overwrite = TRUE)

Arguments

pkg	Ruta a la raíz del paquete.
overwrite	Sobrescribe el flujo de trabajo si ya está instalado.

Details

Para publicar el sitio en la carpeta docs en lugar de la rama gh-pages, usa ros_actions_pkgdown_docs().

Value

Devuelve NULL de forma invisible. Se llama por sus efectos secundarios.

Generación del sitio

Usa ros_build() para generar el sitio de forma local. Consulta pkgdown::build_site() para las opciones de generación.

See Also

Flujos de trabajo de GitHub Actions: ros_actions_check_cron(), ros_actions_pkgdown_docs()

Sitios pkgdown: ros_actions_pkgdown_docs(), ros_build()

Examples

pkg <- file.path(tempdir(), "pkgdown-branch")
if (!dir.exists(pkg)) {
  dir.create(pkg)
}
ros_actions_pkgdown_branch(pkg)

---

Crea un sitio en ⁠/docs⁠ mediante GitHub Actions

Description

Instala un flujo de trabajo de GitHub Actions que genera el sitio pkgdown del paquete en la carpeta docs del repositorio.

Usage

ros_actions_pkgdown_docs(pkg = ".", overwrite = TRUE)

Arguments

pkg	Ruta a la raíz del paquete.
overwrite	Sobrescribe el flujo de trabajo si ya está instalado.

Details

El resultado final es equivalente a ejecutar ros_build(), pero este comando se ejecuta en GitHub, no localmente.

Para publicar el sitio en la rama gh-pages en lugar de la carpeta docs, usa ros_actions_pkgdown_branch().

Value

Devuelve NULL de forma invisible. Se llama por sus efectos secundarios.

Generación del sitio

Usa ros_build() para generar el sitio de forma local. Consulta pkgdown::build_site() para las opciones de generación.

See Also

Flujos de trabajo de GitHub Actions: ros_actions_check_cron(), ros_actions_pkgdown_branch()

Sitios pkgdown: ros_actions_pkgdown_branch(), ros_build()

Examples

pkg <- file.path(tempdir(), "pkgdown-docs")
if (!dir.exists(pkg)) {
  dir.create(pkg)
}
ros_actions_pkgdown_docs(pkg)

---

Añade una insignia de rOpenSpain a tu archivo README

Description

Añade una insignia de rOpenSpain que redirige a https://ropenspain.es/ en tu archivo README:

Usage

ros_badge_ropenspain(install = TRUE)

Arguments

install

Valor lógico. Si es TRUE, la insignia se instala en README.md o README.Rmd. Si es FALSE, muestra un mensaje con el código Markdown correspondiente.

Details

Value

Si install es TRUE, devuelve un valor lógico de forma invisible que indica si se ha añadido la insignia. Si install es FALSE, muestra el código Markdown de la insignia y devuelve NULL de forma invisible. Se llama por sus efectos secundarios.

See Also

usethis::use_badge() para añadir otras insignias al archivo README y ros_pals para las paletas de colores de rOpenSpain.

Recursos de identidad visual: ros_pals

Examples

ros_badge_ropenspain(install = FALSE)

---

Genera tu sitio pkgdown de forma local

Description

Esta función envuelve pkgdown::build_site().

Usage

ros_build(pkg = ".", ...)

Arguments

pkg	Ruta a la raíz del paquete.
...	Argumentos adicionales que se pasan a pkgdown::build_site().

Details

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.

A diferencia de ros_actions_pkgdown_branch(), este proceso se ejecuta de forma local.

Value

Devuelve NULL de forma invisible. Se llama por sus efectos secundarios.

See Also

pkgdown::build_site() para las opciones de generación, ros_actions_pkgdown_docs() y ros_actions_pkgdown_branch() para generar y publicar el sitio mediante GitHub Actions.

Sitios pkgdown: ros_actions_pkgdown_branch(), ros_actions_pkgdown_docs()

Examples

ros_build()

---

Paletas de colores de rOpenSpain

Description

Paletas de colores basadas en el tema de rOpenSpain.

Usage

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)

Arguments

n	Número de colores.
alpha	Valor alfa (transparencia) de los colores. alpha = 1 es opaco y alpha = 0 es totalmente transparente.
rev	Valor lógico. Si es TRUE, devuelve los colores en orden inverso.

Value

Devuelve un vector de caracteres con los colores en formato hexadecimal.

See Also

grDevices::colorRampPalette() para interpolar colores, grDevices::adjustcolor() para ajustar la transparencia y scales::show_col() para visualizar una paleta.

Recursos de identidad visual: ros_badge_ropenspain()

Examples

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))

---