Package 'rostemplate'

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-07-11 13:28:12 UTC
Source: https://github.com/rOpenSpain/rostemplate

Help Index


Crea una acción GitHub que comprueba tu paquete de manera regular

Description

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.

Usage

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

Arguments

pkg

Ruta a la raíz del paquete.

overwrite

Sobreescribe la acción si ya se encuntra instalada.

Details

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.


Instala una acción GitHub que genera tu sitio en la rama gh-pages

Description

Instala una acción GitHub 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

Sobreescribe la acción si ya se encuntra instalada.

See Also

ros_build(), ros_actions_pkgdown_docs()


Instala una acción GitHub que crea tu sitio en la carpeta ⁠/docs⁠

Description

Esta acción GitHub 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

Sobreescribe la acción si ya se encuntra instalada.

Details

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.

See Also

ros_build(), ros_actions_pkgdown_branch().


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: rOpenSpain

Usage

ros_badge_ropenspain(install = TRUE)

Arguments

install

TRUE/FALSE. Si es TRUE la insignia se instala en el archivo README.md/README.Rmd. Si es FALSE muestra un mensaje con el código markdown correspondiente.

Value

Insignia en markdown o mensaje con el código markdown a introducir.

See Also

usethis::use_badge()

Examples

ros_badge_ropenspain(install = FALSE)

Genera tu sitio pkgdown en local

Description

Esta función es un wrapper de 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.

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(), esta acción se ejecuta por el usuario.

See Also

ros_actions_pkgdown_branch(), pkgdown::build_site().


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 totalmente transparente

rev

Valor lógico que indica si los colores se han de mostar en orden inverso.

Value

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