{"id":19070286,"url":"https://github.com/ropenspain/rostemplate","last_synced_at":"2025-04-28T14:13:21.324Z","repository":{"id":41291504,"uuid":"319126225","full_name":"rOpenSpain/rostemplate","owner":"rOpenSpain","description":"Plantilla pkgdown para los paquetes de rOpenSpain","archived":false,"fork":false,"pushed_at":"2025-04-24T10:45:03.000Z","size":108686,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-28T14:13:13.309Z","etag":null,"topics":["github-actions","pkgdown","r","r-package","ropenspain","rstats","template","yaml"],"latest_commit_sha":null,"homepage":"https://ropenspain.github.io/rostemplate/","language":"R","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rOpenSpain.png","metadata":{"files":{"readme":"README.Rmd","changelog":"NEWS.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":"codemeta.json","zenodo":null}},"created_at":"2020-12-06T20:35:46.000Z","updated_at":"2025-03-18T20:38:11.000Z","dependencies_parsed_at":"2023-02-17T18:30:44.092Z","dependency_job_id":"d1e251c2-dae5-4bed-bed2-5a601ba5b346","html_url":"https://github.com/rOpenSpain/rostemplate","commit_stats":{"total_commits":299,"total_committers":5,"mean_commits":59.8,"dds":0.2775919732441472,"last_synced_commit":"f9f70769d2a43539997b9316dfb87201971b5661"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rOpenSpain%2Frostemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rOpenSpain%2Frostemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rOpenSpain%2Frostemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rOpenSpain%2Frostemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rOpenSpain","download_url":"https://codeload.github.com/rOpenSpain/rostemplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251326851,"owners_count":21571636,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-actions","pkgdown","r","r-package","ropenspain","rstats","template","yaml"],"created_at":"2024-11-09T01:17:55.004Z","updated_at":"2025-04-28T14:13:21.300Z","avatar_url":"https://github.com/rOpenSpain.png","language":"R","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\noutput: github_document\n---\n\n\u003c!-- README.md is generated from README.Rmd. Please edit that file --\u003e\n\n```{r, include = FALSE}\nknitr::opts_chunk$set(\n  collapse = TRUE,\n  comment = \"#\u003e\",\n  tidy = \"styler\",\n  fig.path = \"man/figures/README-\",\n  out.width = \"100%\"\n)\n```\n\n# rostemplate \u003cimg src=\"man/figures/logo.png\" align=\"right\" width=\"120\"/\u003e\n\n\u003c!-- badges: start --\u003e\n\n[![rOS-badge](https://ropenspain.github.io/rostemplate/reference/figures/ropenspain-badge.svg)](https://ropenspain.es/)\n[![r-universe](https://ropenspain.r-universe.dev/badges/rostemplate)](https://ropenspain.r-universe.dev/rostemplate)\n[![R build\nstatus](https://github.com/ropenspain/rostemplate/workflows/R-CMD-check/badge.svg)](https://github.com/ropenspain/rostemplate/actions)\n[![codecov](https://codecov.io/gh/ropenspain/rostemplate/branch/main/graph/badge.svg)](https://app.codecov.io/gh/ropenspain/rostemplate)\n[![lifecycle](https://lifecycle.r-lib.org/articles/figures/lifecycle-experimental.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)\n\n\u003c!-- badges: end --\u003e\n\nEsta librería es una plantilla **pkgdown** adaptada al sitio web de\n[rOpenSpain](https://ropenspain.es/).\n\nEsta plantilla es una plantilla privada para uso exclusivo de los paquetes de\n**rOpenSpain**. Por favor, no la uses para otros paquetes.\n\n## Introducción\n\nEste paquete proporciona una plantilla de **pkgdown** adaptada a la empleada por\nla comunidad [rOpenSpain](https://ropenspain.es/), que a su vez es una\nadaptación de la plantilla\n[Universal](https://bootstraptemple.com/universal-business-e-commerce-template)\ncreada por [bootstraptemple](https://bootstraptemple.com/) con la variación de\ncolor **violet**.\n\n## Configuración previa\n\nEn la raíz del proyecto ha de existir un archivo `_pkgdown.yml` con al menos las\nsiguientes líneas:\n\n``` yaml\ntemplate:\n  bootstrap: 5\n  package: rostemplate\n  # No pongas la siguiente línea!\n  default_assets: false\n```\n\nPuedes encontrar información sobre cómo configurar otras opciones en\n`_pkgdown.yml` [aquí](https://pkgdown.r-lib.org/articles/pkgdown.html).\n\nAdicionalmente, es necesario añadir al archivo `.Rbuildignore` las siguientes\nlíneas:\n\n``` default\n^\\.github$\n^docs$\n^_pkgdown\\.yml$\n```\n\n## Uso de la plantilla\n\nEsta sección detalla diferentes opciones para generar un sitio estático para el\npaquete deseado con el formato definido por esta plantilla. El resultado de este\npaso es la generación de un sitio estático compuesto de los archivos `html`,\n`css`, etc. basados en el paquete de **R** para el que se está generando el\nsitio.\n\n### Con GitHub actions - CI\n\nGitHub Actions permite automatizar procesos cuando se activa un *trigger*. En\neste caso se han preparado dos acciones que actualizan el sitio estático cada\nvez que se añade un *commit* al repositorio.\n\nLos flujos de trabajo consisten en archivos con extensión `.yaml`. La acción\n[rostemplate-docs.yaml](https://github.com/ropenspain/rostemplate/blob/main/inst/yaml/rostemplate-docs.yaml)\ncrea el sitio estático en la carpeta `./docs` mientras que\n[rostemplate-gh-pages.yaml](https://github.com/ropenspain/rostemplate/blob/main/inst/yaml/rostemplate-gh-pages.yaml)\ncrea el sitio estático en el branch `gh-pages`.\n\nPara configurar esta opción, es necesario disponer en el repositorio de una\ncarpeta en la ruta `.github/workflows` y copiar la acción deseada en dicha\ncarpeta.\n\n#### Alternativa usando las funciones de rostemplate\n\nAunque el uso del paquete **rostemplate** en si no es necesario con GitHub\nactions, se han desarrollado dos funciones que automatizan esta configuración de\nmanera automática. Estas funciones simplemente crean el directorio\n`.github/workflows` si no existiera previamente y copian los archivos\nsolicitados en la ruta correspondiente. Adicionalmente, crean los archivos\n`.Rbuildignore` y `.github/.gitignore`, que ignoran ciertos archivos cuando se\ncompila el paquete:\n\n```{r eval=FALSE}\n# Instalación via r-universe\n\ninstall.packages(\"rostemplate\",\n  repos = c(\"https://ropenspain.r-universe.dev\", \"https://cloud.r-project.org\")\n)\n\n# Deploy to gh-branch\n\nrostemplate::ros_actions_pkgdown_branch()\n\n\n# Deploy to docs folder\nrostemplate::ros_actions_pkgdown_docs()\n```\n\nEs posible cambiar el evento que desencadena la actualización del sitio:\n\n``` yaml\n# Actualiza en cada commit - por defecto\non:\n  push:\n    branches:\n      - main\n      - master\n      \n# Actualiza cuando se modifica un archivo específico: _pkgdown.yaml\n\non:\n  push:\n    paths:\n      - '_pkgdown.yaml'\n```\n\nMás información sobre cómo adaptar los *triggers* de la acción\n[aquí](https://docs.github.com/es/free-pro-team@latest/actions/reference/events-that-trigger-workflows).\n\n### RStudio - manual\n\nEl sitio estático se puede generar igualmente desde una sesión local en\n**RStudio**. Para ello, es necesario instalar este paquete:\n\n```{r eval=FALSE}\ninstall.packages(\"rostemplate\",\n  repos = c(\"https://ropenspain.r-universe.dev\", \"https://cloud.r-project.org\")\n)\n```\n\nUna vez instalado, se ha de ejecutar este script:\n\n```{r eval=FALSE}\nrostemplate::ros_build()\n```\n\nLa función `rostemplate::ros_build()` no es más que un alias de\n`pkgdown::build_site()`, aportando únicamente un control sobre la configuración\ndel archivo `_pkgdown.yml`\n\nUna vez generado el sitio, es necesario actualizar el repositorio remoto en\nGitHub mediante un *commit*.\n\n## GitHub Pages\n\nUna vez generado el sitio estático y subido al repositorio en GitHub, el último\npaso es activar el sitio web a través de los *Settings* de nuestro repositorio\n(*Setting\\\u003eGitHub Pages*), seleccionando el origen deseado (`gh-pages`,\n`main/docs`, etc.).\n\n## Contributors\n\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\nAll 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!\n\n### Code\n\n\u003ctable class=\"table allctb-table\" \u003e\n\n\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\n\u003ca href=\"https://github.com/dieghernan\"\u003e\n\u003cimg src=\"https://avatars.githubusercontent.com/u/25656809?v=4\" width=\"100px;\" class=\"allctb-avatar\" alt=\"\"/\u003e\n\u003c/a\u003e\u003cbr\u003e\n\u003ca href=\"https://github.com/rOpenSpain/rostemplate/commits?author=dieghernan\"\u003edieghernan\u003c/a\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003c/table\u003e\n\n\n### Issues\n\n\u003ctable class=\"table allctb-table\" \u003e\n\n\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\n\u003ca href=\"https://github.com/Enchufa2\"\u003e\n\u003cimg src=\"https://avatars.githubusercontent.com/u/4542928?v=4\" width=\"100px;\" class=\"allctb-avatar\" alt=\"\"/\u003e\n\u003c/a\u003e\u003cbr\u003e\n\u003ca href=\"https://github.com/rOpenSpain/rostemplate/issues?q=is%3Aissue+commenter%3AEnchufa2\"\u003eEnchufa2\u003c/a\u003e\n\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\n\u003ca href=\"https://github.com/llrs\"\u003e\n\u003cimg src=\"https://avatars.githubusercontent.com/u/6818218?u=c0a96a5dc32b3035f057ee75a7679680363b1a89\u0026v=4\" width=\"100px;\" class=\"allctb-avatar\" alt=\"\"/\u003e\n\u003c/a\u003e\u003cbr\u003e\n\u003ca href=\"https://github.com/rOpenSpain/rostemplate/issues?q=is%3Aissue+commenter%3Allrs\"\u003ellrs\u003c/a\u003e\n\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropenspain%2Frostemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fropenspain%2Frostemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fropenspain%2Frostemplate/lists"}