Package 'rostemplate'

Crea un workflow de GitHub Actions que comprueba tu paquete regularmente

Description

El workflow de GitHub Actions creado ejecuta ⁠R CMD check⁠ para tu paquete. La configuración por defecto ejecuta el check de manera mensual los días 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 workflow si ya se encuentra instalado.

Details

Puedes aprender cómo configurar la acción cron 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

Se llama por sus efectos secundarios y devuelve NULL de forma invisible.

Examples

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

---

Instala un workflow de GitHub Actions que genera tu sitio en gh-pages

Description

Instala un workflow de GitHub Actions que crea el sitio pkgdown de tu paquete en la rama gh-pages de tu repositorio.

Usage

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

Arguments

pkg	Ruta a la raíz del paquete.
overwrite	Sobrescribe el workflow si ya se encuentra instalado.

Value

Se llama por sus efectos secundarios y devuelve NULL de forma invisible.

See Also

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)

---

Instala un workflow de GitHub Actions que crea tu sitio en ⁠/docs⁠

Description

Este workflow de GitHub Actions genera tu sitio pkgdown en la carpeta docs de tu repositorio.

Usage

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

Arguments

pkg	Ruta a la raíz del paquete.
overwrite	Sobrescribe el workflow si ya se encuentra instalado.

Details

El resultado final es equivalente a ejecutar ros_build(), con la diferencia de que este comando se ejecuta en GitHub en lugar de ejecutarse localmente.

Value

Se llama por sus efectos secundarios y devuelve NULL de forma invisible.

See Also

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

Se llama por sus efectos secundarios. Si install es FALSE, muestra el código markdown de la insignia.

See Also

usethis::use_badge()

Examples

ros_badge_ropenspain(install = FALSE)

---

Genera tu sitio pkgdown en local

Description

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

Usage

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

Arguments

pkg

Path to package.

...

Arguments passed on to pkgdown::build_site examples Run examples? run_dont_run Run examples that are surrounded in \dontrun? seed Seed used to initialize random number generation in order to make article output reproducible. An integer scalar or NULL for no seed. lazy If TRUE, will only rebuild articles and reference pages if the source is newer than the destination. override An optional named list used to temporarily override values in ⁠_pkgdown.yml⁠ preview If TRUE, or is.na(preview) && interactive(), will preview freshly generated section in browser. devel Use development or deployment process? If TRUE, uses lighter-weight process suitable for rapid iteration; it will run examples and vignettes in the current process, and will load code with pkgload::load_all(). If FALSE, will first install the package to a temporary library, and will run all examples and vignettes in a new process. build_site() defaults to devel = FALSE so that you get high fidelity outputs when you building the complete site; build_reference(), build_home() and friends default to devel = TRUE so that you can rapidly iterate during development. new_process If TRUE, will run build_site() in a separate process. This enhances reproducibility by ensuring nothing that you have loaded in the current process affects the build process. install If TRUE, will install the package in a temporary library so it is available for vignettes. quiet If FALSE, generate build messages for build functions that take quiet arguments.

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⁠.

Al contrario que ros_actions_pkgdown_branch(), este workflow se ejecuta localmente.

Value

Se llama por sus efectos secundarios y devuelve NULL de forma invisible.

See Also

pkgdown::build_site().

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, muestra los colores en orden inverso.

Value

Un vector de colores.

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

---