rostemplate
Plantilla pkgdown para los paquetes de rOpenSpain
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.7%) to scientific vocabulary
Keywords
github-actions
pkgdown
r
r-package
ropenspain
rstats
template
yaml
Keywords from Contributors
interpretability
standardization
hack
reverse-geocoding
geocoding
intergovernmental-organizations
igo
correlates-of-war
address
nominatim
Last synced: 4 months ago
·
JSON representation
·
Repository
Plantilla pkgdown para los paquetes de rOpenSpain
Basic Info
- Host: GitHub
- Owner: rOpenSpain
- License: other
- Language: R
- Default Branch: main
- Homepage: https://ropenspain.github.io/rostemplate/
- Size: 119 MB
Statistics
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
- Releases: 2
Topics
github-actions
pkgdown
r
r-package
ropenspain
rstats
template
yaml
Created about 5 years ago
· Last pushed 4 months ago
Metadata Files
Readme
Changelog
License
Citation
Codemeta
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
tidy = "styler",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rostemplate
[](https://ropenspain.es/)
[](https://ropenspain.r-universe.dev/rostemplate)
[](https://github.com/ropenspain/rostemplate/actions)
[](https://app.codecov.io/gh/ropenspain/rostemplate)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
Esta librería es una plantilla **pkgdown** adaptada al sitio web de
[rOpenSpain](https://ropenspain.es/).
Esta plantilla es una plantilla privada para uso exclusivo de los paquetes de
**rOpenSpain**. Por favor, no la uses para otros paquetes.
## Introducción
Este paquete proporciona una plantilla de **pkgdown** adaptada a la empleada por
la comunidad [rOpenSpain](https://ropenspain.es/), que a su vez es una
adaptación de la plantilla
[Universal](https://templatesherpa.com/universal-business-e-commerce-template)
creada por [bootstraptemple](https://templatesherpa.com/) con la variación de
color **violet**.
## Configuración previa
En la raíz del proyecto ha de existir un archivo `_pkgdown.yml` con al menos las
siguientes líneas:
``` yaml
template:
bootstrap: 5
package: rostemplate
# No pongas la siguiente línea!
default_assets: false
```
Puedes encontrar información sobre cómo configurar otras opciones en
`_pkgdown.yml` [aquí](https://pkgdown.r-lib.org/articles/pkgdown.html).
Adicionalmente, es necesario añadir al archivo `.Rbuildignore` las siguientes
líneas:
``` default
^\.github$
^docs$
^_pkgdown\.yml$
```
## Uso de la plantilla
Esta sección detalla diferentes opciones para generar un sitio estático para el
paquete deseado con el formato definido por esta plantilla. El resultado de este
paso es la generación de un sitio estático compuesto de los archivos `html`,
`css`, etc. basados en el paquete de **R** para el que se está generando el
sitio.
### Con GitHub actions - CI
GitHub Actions permite automatizar procesos cuando se activa un *trigger*. En
este caso se han preparado dos acciones que actualizan el sitio estático cada
vez que se añade un *commit* al repositorio.
Los flujos de trabajo consisten en archivos con extensión `.yaml`. La acción
[rostemplate-docs.yaml](https://github.com/ropenspain/rostemplate/blob/main/inst/yaml/rostemplate-docs.yaml)
crea el sitio estático en la carpeta `./docs` mientras que
[rostemplate-gh-pages.yaml](https://github.com/ropenspain/rostemplate/blob/main/inst/yaml/rostemplate-gh-pages.yaml)
crea el sitio estático en el branch `gh-pages`.
Para configurar esta opción, es necesario disponer en el repositorio de una
carpeta en la ruta `.github/workflows` y copiar la acción deseada en dicha
carpeta.
#### Alternativa usando las funciones de rostemplate
Aunque el uso del paquete **rostemplate** en si no es necesario con GitHub
actions, se han desarrollado dos funciones que automatizan esta configuración de
manera automática. Estas funciones simplemente crean el directorio
`.github/workflows` si no existiera previamente y copian los archivos
solicitados en la ruta correspondiente. Adicionalmente, crean los archivos
`.Rbuildignore` y `.github/.gitignore`, que ignoran ciertos archivos cuando se
compila el paquete:
```{r eval=FALSE}
# Instalación via r-universe
install.packages("rostemplate",
repos = c("https://ropenspain.r-universe.dev", "https://cloud.r-project.org")
)
# Deploy to gh-branch
rostemplate::ros_actions_pkgdown_branch()
# Deploy to docs folder
rostemplate::ros_actions_pkgdown_docs()
```
Es posible cambiar el evento que desencadena la actualización del sitio:
``` yaml
# Actualiza en cada commit - por defecto
on:
push:
branches:
- main
- master
# Actualiza cuando se modifica un archivo específico: _pkgdown.yaml
on:
push:
paths:
- '_pkgdown.yaml'
```
Más información sobre cómo adaptar los *triggers* de la acción
[aquí](https://docs.github.com/es/free-pro-team@latest/actions/reference/events-that-trigger-workflows).
### RStudio - manual
El sitio estático se puede generar igualmente desde una sesión local en
**RStudio**. Para ello, es necesario instalar este paquete:
```{r eval=FALSE}
install.packages("rostemplate",
repos = c("https://ropenspain.r-universe.dev", "https://cloud.r-project.org")
)
```
Una vez instalado, se ha de ejecutar este script:
```{r eval=FALSE}
rostemplate::ros_build()
```
La función `rostemplate::ros_build()` no es más que un alias de
`pkgdown::build_site()`, aportando únicamente un control sobre la configuración
del archivo `_pkgdown.yml`
Una vez generado el sitio, es necesario actualizar el repositorio remoto en
GitHub mediante un *commit*.
## GitHub Pages
Una vez generado el sitio estático y subido al repositorio en GitHub, el último
paso es activar el sitio web a través de los *Settings* de nuestro repositorio
(*Setting\>GitHub Pages*), seleccionando el origen deseado (`gh-pages`,
`main/docs`, etc.).
## Contributors
All contributions to this project are gratefully acknowledged using the [`allcontributors` package](https://github.com/ropensci/allcontributors) following the [allcontributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
### Code
|
dieghernan |
|
Enchufa2 |
llrs |
Owner
- Name: rOpenSpain
- Login: rOpenSpain
- Kind: organization
- Email: hola@ropenspain.es
- Location: Spain
- Website: http://ropenspain.es
- Repositories: 21
- Profile: https://github.com/rOpenSpain
rOpenSci is our form, Spanish public data our matter
Citation (CITATION.cff)
# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
cff-version: 1.2.0
message: 'To cite package "rostemplate" in publications use:'
type: software
license: MIT
title: 'rostemplate: Plantilla ''pkgdown'' para los paquetes de ''rOpenSpain'''
version: 0.2.0.9000
abstract: Plantilla privada para uso exclusivo de los paquetes de rOpenSpain.
authors:
- family-names: Hernangómez
given-names: Diego
email: diego.hernangomezherrero@gmail.com
orcid: https://orcid.org/0000-0001-8457-4658
affiliation: rOpenSpain
preferred-citation:
type: manual
title: 'rostemplate: Plantilla pkgdown para los paquetes de rOpenSpain'
authors:
- family-names: Hernangómez
given-names: Diego
email: diego.hernangomezherrero@gmail.com
orcid: https://orcid.org/0000-0001-8457-4658
affiliation: rOpenSpain
year: '2025'
url: https://ropenspain.github.io/rostemplate/
abstract: Plantilla privada para uso exclusivo de los paquetes de rOpenSpain.
repository-code: https://github.com/ropenspain/rostemplate
url: https://ropenspain.github.io/rostemplate/
contact:
- family-names: Hernangómez
given-names: Diego
email: diego.hernangomezherrero@gmail.com
orcid: https://orcid.org/0000-0001-8457-4658
affiliation: rOpenSpain
keywords:
- github-actions
- pkgdown
- r
- r-package
- ropenspain
- rstats
- template
- yaml
references:
- type: software
title: 'R: A Language and Environment for Statistical Computing'
notes: Depends
url: https://www.R-project.org/
authors:
- name: R Core Team
institution:
name: R Foundation for Statistical Computing
address: Vienna, Austria
year: '2025'
version: '>= 3.6'
- type: software
title: pkgdown
abstract: 'pkgdown: Make Static HTML Documentation for a Package'
notes: Imports
url: https://pkgdown.r-lib.org/
repository: https://CRAN.R-project.org/package=pkgdown
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: Hesselberth
given-names: Jay
orcid: https://orcid.org/0000-0002-6299-179X
- family-names: Salmon
given-names: Maëlle
orcid: https://orcid.org/0000-0002-2815-0399
- family-names: Roy
given-names: Olivier
- family-names: Brüggemann
given-names: Salim
orcid: https://orcid.org/0000-0002-5329-5987
year: '2025'
doi: 10.32614/CRAN.package.pkgdown
version: '>= 2.0.8'
- type: software
title: styler
abstract: 'styler: Non-Invasive Pretty Printing of R Code'
notes: Imports
url: https://styler.r-lib.org
repository: https://CRAN.R-project.org/package=styler
authors:
- family-names: Müller
given-names: Kirill
email: kirill@cynkra.com
orcid: https://orcid.org/0000-0002-1416-3412
- family-names: Walthert
given-names: Lorenz
email: lorenz.walthert@icloud.com
year: '2025'
doi: 10.32614/CRAN.package.styler
- type: software
title: usethis
abstract: 'usethis: Automate Package and Project Setup'
notes: Imports
url: https://usethis.r-lib.org
repository: https://CRAN.R-project.org/package=usethis
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: Bryan
given-names: Jennifer
email: jenny@posit.co
orcid: https://orcid.org/0000-0002-6983-2759
- family-names: Barrett
given-names: Malcolm
email: malcolmbarrett@gmail.com
orcid: https://orcid.org/0000-0003-0299-5825
- family-names: Teucher
given-names: Andy
email: andy.teucher@posit.co
orcid: https://orcid.org/0000-0002-7840-692X
year: '2025'
doi: 10.32614/CRAN.package.usethis
version: '>= 2.0.0'
- type: software
title: utils
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
institution:
name: R Foundation for Statistical Computing
address: Vienna, Austria
year: '2025'
- type: software
title: knitr
abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
notes: Suggests
url: https://yihui.org/knitr/
repository: https://CRAN.R-project.org/package=knitr
authors:
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
year: '2025'
doi: 10.32614/CRAN.package.knitr
- type: software
title: rmarkdown
abstract: 'rmarkdown: Dynamic Documents for R'
notes: Suggests
url: https://pkgs.rstudio.com/rmarkdown/
repository: https://CRAN.R-project.org/package=rmarkdown
authors:
- family-names: Allaire
given-names: JJ
email: jj@posit.co
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
- family-names: Dervieux
given-names: Christophe
email: cderv@posit.co
orcid: https://orcid.org/0000-0003-4474-2498
- family-names: McPherson
given-names: Jonathan
email: jonathan@posit.co
- family-names: Luraschi
given-names: Javier
- family-names: Ushey
given-names: Kevin
email: kevin@posit.co
- family-names: Atkins
given-names: Aron
email: aron@posit.co
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
- family-names: Cheng
given-names: Joe
email: joe@posit.co
- family-names: Chang
given-names: Winston
email: winston@posit.co
- family-names: Iannone
given-names: Richard
email: rich@posit.co
orcid: https://orcid.org/0000-0003-3925-190X
year: '2025'
doi: 10.32614/CRAN.package.rmarkdown
- type: software
title: scales
abstract: 'scales: Scale Functions for Visualization'
notes: Suggests
url: https://scales.r-lib.org
repository: https://CRAN.R-project.org/package=scales
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
- family-names: Pedersen
given-names: Thomas Lin
email: thomas.pedersen@posit.co
orcid: https://orcid.org/0000-0002-5147-4711
- family-names: Seidel
given-names: Dana
year: '2025'
doi: 10.32614/CRAN.package.scales
- type: software
title: testthat
abstract: 'testthat: Unit Testing for R'
notes: Suggests
url: https://testthat.r-lib.org
repository: https://CRAN.R-project.org/package=testthat
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2025'
doi: 10.32614/CRAN.package.testthat
version: '>= 3.0.0'
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "rostemplate",
"description": "Plantilla privada para uso exclusivo de los paquetes de rOpenSpain.",
"name": "rostemplate: Plantilla 'pkgdown' para los paquetes de 'rOpenSpain'",
"relatedLink": "https://ropenspain.github.io/rostemplate/",
"codeRepository": "https://github.com/ropenspain/rostemplate",
"issueTracker": "https://github.com/ropenspain/rostemplate/issues",
"license": "https://spdx.org/licenses/MIT",
"version": "0.2.0.9000",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.5.1 (2025-06-13 ucrt)",
"author": [
{
"@type": "Person",
"givenName": "Diego",
"familyName": "Hernangmez",
"email": "diego.hernangomezherrero@gmail.com",
"@id": "https://orcid.org/0000-0001-8457-4658"
}
],
"copyrightHolder": [
{
"@type": "Person",
"givenName": "Diego",
"familyName": "Hernangmez",
"email": "diego.hernangomezherrero@gmail.com",
"@id": "https://orcid.org/0000-0001-8457-4658"
}
],
"maintainer": [
{
"@type": "Person",
"givenName": "Diego",
"familyName": "Hernangmez",
"email": "diego.hernangomezherrero@gmail.com",
"@id": "https://orcid.org/0000-0001-8457-4658"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "knitr",
"name": "knitr",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=knitr"
},
{
"@type": "SoftwareApplication",
"identifier": "rmarkdown",
"name": "rmarkdown",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rmarkdown"
},
{
"@type": "SoftwareApplication",
"identifier": "scales",
"name": "scales",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=scales"
},
{
"@type": "SoftwareApplication",
"identifier": "testthat",
"name": "testthat",
"version": ">= 3.0.0",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=testthat"
}
],
"softwareRequirements": {
"1": {
"@type": "SoftwareApplication",
"identifier": "R",
"name": "R",
"version": ">= 3.6"
},
"2": {
"@type": "SoftwareApplication",
"identifier": "pkgdown",
"name": "pkgdown",
"version": ">= 2.0.8",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=pkgdown"
},
"3": {
"@type": "SoftwareApplication",
"identifier": "styler",
"name": "styler",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=styler"
},
"4": {
"@type": "SoftwareApplication",
"identifier": "usethis",
"name": "usethis",
"version": ">= 2.0.0",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=usethis"
},
"5": {
"@type": "SoftwareApplication",
"identifier": "utils",
"name": "utils"
},
"SystemRequirements": null
},
"isPartOf": "https://ropenspain.es/",
"keywords": [
"github-actions",
"pkgdown",
"r",
"r-package",
"ropenspain",
"rstats",
"template",
"yaml"
],
"fileSize": "224.56KB",
"citation": [
{
"@type": "SoftwareSourceCode",
"datePublished": "2025",
"author": [
{
"@type": "Person",
"givenName": "Diego",
"familyName": "Hernangmez"
}
],
"name": "{rostemplate}: Plantilla {pkgdown} para los paquetes de {rOpenSpain}",
"url": "https://ropenspain.github.io/rostemplate/"
}
],
"releaseNotes": "https://github.com/ropenspain/rostemplate/blob/main/NEWS.md",
"readme": "https://github.com/rOpenSpain/rostemplate/blob/main/README.md",
"contIntegration": [
"https://github.com/ropenspain/rostemplate/actions",
"https://app.codecov.io/gh/ropenspain/rostemplate"
],
"developmentStatus": "https://lifecycle.r-lib.org/articles/stages.html#experimental"
}
GitHub Events
Total
- Issues event: 1
- Watch event: 1
- Delete event: 1
- Issue comment event: 1
- Push event: 72
- Pull request event: 1
- Create event: 1
Last Year
- Issues event: 1
- Watch event: 1
- Delete event: 1
- Issue comment event: 1
- Push event: 72
- Pull request event: 1
- Create event: 1
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| dieghernan | d****o@g****m | 244 |
| GitHub Actions | a****s@g****m | 74 |
| github-actions[bot] | 4****] | 19 |
| imgbot[bot] | 3****] | 2 |
| dependabot[bot] | 4****] | 2 |
Committer Domains (Top 20 + Academic)
github.com: 1
Issues and Pull Requests
Last synced: 8 months ago
All Time
- Total issues: 3
- Total pull requests: 20
- Average time to close issues: 6 months
- Average time to close pull requests: about 13 hours
- Total issue authors: 1
- Total pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 0.2
- Merged pull requests: 17
- Bot issues: 0
- Bot pull requests: 4
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 2 hours
- Issue authors: 0
- Pull request authors: 2
- Average comments per issue: 0
- Average comments per pull request: 0.5
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 1
Top Authors
Issue Authors
- dieghernan (2)
Pull Request Authors
- dieghernan (18)
- imgbot[bot] (3)
- dependabot[bot] (2)
Top Labels
Issue Labels
documentation (1)
help wanted (1)
Pull Request Labels
dependencies (2)
Dependencies
.github/workflows/roscron-check-standard.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/rostemplate-docs.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/rostemplate-gh-pages.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/update-citation-cff.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/setup-r v1 composite
- r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/update-docs.yaml
actions
- actions/checkout v2 composite
- r-lib/actions/check-r-package v2 composite
- r-lib/actions/setup-pandoc v2 composite
- r-lib/actions/setup-r v2 composite
- r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION
cran
- R >= 3.6 depends
- pkgdown >= 2.0.0 imports
- usethis >= 2.0.0 imports
- utils * imports
- knitr * suggests
- rmarkdown * suggests
- scales * suggests
- testthat >= 3.0.0 suggests