Nuevo lanzamiento

.Rbuildignore

@@ -30,3 +30,4 @@
 ^CONTRIBUTING\.md$
 ^Rplots\.pdf$
 ^vignettes/precompute\.Rmd\.orig$
+

.github/workflows/rostemplate-docs.yaml

@@ -1,8 +1,8 @@
 # Workflow derived from https://github.com/r-lib/actions/tree/master/examples
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
+  workflow_dispatch:
   push:
-    branches: [main, master]
     tags: ['*']
 
 name: rostemplate-docs

.github/workflows/rostemplate-gh-pages.yaml

@@ -41,5 +41,5 @@ jobs:
         run: |
           git config --local user.name "github-actions[bot]"
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
-          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, clean = TRUE)'
 

.gitignore

@@ -34,3 +34,6 @@ CRAN-SUBMISSION
 cran-comments.md
 .Rdata
 Rplots.pdf
+*.html
+R-version
+depends.Rds

CITATION.cff

@@ -1,14 +1,14 @@
-# -----------------------------------------------------------
-# CITATION file created with {cffr} R package, v1.0.0
+# --------------------------------------------
+# 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.1.1.9100
+version: 0.2.0
 abstract: Plantilla privada para uso exclusivo de los paquetes de rOpenSpain.
 authors:
 - family-names: Hernangómez
@@ -66,7 +66,7 @@ references:
   authors:
   - family-names: Wickham
     given-names: Hadley
-    email: hadley@rstudio.com
+    email: hadley@posit.co
     orcid: https://orcid.org/0000-0003-4757-117X
   - family-names: Hesselberth
     given-names: Jay
@@ -210,3 +210,4 @@ references:
     email: [email protected]
   year: '2024'
   version: '>= 3.0.0'
+

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rostemplate
 Title: Plantilla 'pkgdown' para los paquetes de 'rOpenSpain'
-Version: 0.1.1.9100
+Version: 0.2.0
 Authors@R: 
     person("Diego", "Hernangómez", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-8457-4658", affiliation = "rOpenSpain"))

NEWS.md

@@ -1,15 +1,25 @@
-# rostemplate (development version)
+# rostemplate 0.2.0
 
--   Adapt to BS5 with new pkgdown version.
+**Importante!** Configuración mínima en `pkgdowm.yaml` ha de ser:
+
+``` yaml
+template:
+  bootstrap: 5
+  package: rostemplate
+```
+
+Otros cambios:
+
+-   Adapt to BS5 with new **pkgdown** version.
 -   Documentación en castellano
 -   Añade paletas de colores
 
 # rostemplate 0.0.4
 
--   Use `testthat` package.
+-   Use **testthat** package.
 -   Rename core functions.
 -   Update actions.
--   Update logo and favicons, created with `hexSticker`.
+-   Update logo and favicons, created with **hexSticker**.
 
 # rostemplate 0.0.3
 
@@ -18,7 +28,7 @@
 
 # rostemplate 0.0.2
 
--   Move to rOpenSpain
+-   Move to [**rOpenSpain**](https://github.com/rOpenSpain/rostemplate)**.**
 
 # rostemplate 0.0.1
 

R/ros_actions_pkgdown_branch.R

@@ -2,8 +2,8 @@
 #'
 #' @description
 #'
-#' Instala una acción GitHub que crea el sitio `pkgdown` de tu paquete en la
-#' rama `gh-pages` de tu repositorio.
+#' Instala una acción GitHub que crea el sitio \CRANpkg{pkgdown} de tu paquete
+#' en la rama `gh-pages` de tu repositorio.
 #'
 #' @seealso [ros_build()], [ros_actions_pkgdown_docs()]
 #' @export
@@ -27,24 +27,23 @@ ros_actions_pkgdown_branch <- function(pkg = ".", overwrite = TRUE) {
   }
 
   # Add lines to Rbuildignore
-  linesrbuild <- readLines(rbuildig)
-  newlinesrbuild <-
-    unique(c(linesrbuild, "^\\.github$", "^docs$", "^_pkgdown\\.yml$"))
-  newlinesrbuild <- newlinesrbuild[newlinesrbuild != ""]
-  writeLines(newlinesrbuild, rbuildig)
-
+  usethis::write_union(
+    rbuildig,
+    c(
+      "^docs$", "^_pkgdown\\.yml$", "^_pkgdown\\.yaml$",
+      "^\\.github$", "^pkgdown$"
+    )
+  )
   # Check gitignore
-
   gitignore <- file.path(pkg, ".github", ".gitignore")
   if (!file.exists(gitignore)) {
     file.create(gitignore)
   }
+  usethis::write_union(
+    gitignore,
+    c("*.html", "R-version", "depends.Rds")
+  )
 
-  # Add lines to gitignore
-  lines <- readLines(gitignore)
-  newlines <- unique(c(lines, "*.html", "R-version", "depends.Rds"))
-  newlines <- newlines[newlines != ""]
-  writeLines(newlines, gitignore)
 
   # Get action file
   filepath <-

R/ros_actions_pkgdown_docs.R

@@ -1,15 +1,15 @@
 #' 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.
+#' Esta acción GitHub genera tu sitio \CRANpkg{pkgdown} en la carpeta `docs`
+#' de tu repositorio.
 #'
 #' @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.
 #'
-#' @seealso [ros_build()], [ros_actions_pkgdown_branch()]
+#' @seealso [ros_build()], [ros_actions_pkgdown_branch()].
 #'
 #' @export
 #'
@@ -34,25 +34,24 @@ ros_actions_pkgdown_docs <-
     }
 
     # Add lines to Rbuildignore
-    linesrbuild <- readLines(rbuildignore)
-    newlinesrbuild <-
-      unique(c(linesrbuild, "^\\.github$", "^docs$", "^_pkgdown\\.yml$"))
-    newlinesrbuild <- newlinesrbuild[newlinesrbuild != ""]
-    writeLines(newlinesrbuild, rbuildignore)
+    usethis::write_union(
+      rbuildignore,
+      c(
+        "^docs$", "^_pkgdown\\.yml$", "^_pkgdown\\.yaml$",
+        "^\\.github$", "^pkgdown$"
+      )
+    )
 
     # Check gitignore
-
     gitignore <- file.path(pkg, ".github", ".gitignore")
     if (!file.exists(gitignore)) {
       file.create(gitignore)
     }
+    usethis::write_union(
+      gitignore,
+      c("*.html", "R-version", "depends.Rds")
+    )
 
-    # Add lines to gitignore
-    lines <- readLines(gitignore)
-    newlines <-
-      unique(c(lines, "*.html", "R-version", "depends.Rds"))
-    newlines <- newlines[newlines != ""]
-    writeLines(newlines, gitignore)
 
     # Get action file
     filepath <-

R/ros_badge_ropenspain.R

@@ -1,8 +1,8 @@
-#' Añade una insignia de rOpenSpain a tu archivo `README`
+#' Añade una insignia de **rOpenSpain** a tu archivo `README`
 #'
 #'
 #' @description
-#' Añade una insignia de rOpenSpain que redirige a <https://ropenspain.es/>
+#' Añade una insignia de **rOpenSpain** que redirige a <https://ropenspain.es/>
 #' en tu archivo `README`:
 #'
 #' ```{r, echo=FALSE, results='asis'}
@@ -19,7 +19,7 @@
 #'
 #' @return Insignia en markdown o mensaje con el código markdown a introducir.
 #'
-#' @seealso [`usethis::use_badge()`]
+#' @seealso [usethis::use_badge()]
 #'
 #' @param 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

R/ros_build.R

@@ -1,6 +1,6 @@
-#' Genera tu sitio `pkgdown` en local
+#' Genera tu sitio \CRANpkg{pkgdown} en local
 #'
-#' Esta función es un wrapper de [pkgdown::build_site()]
+#' Esta función es un wrapper de [pkgdown::build_site()].
 #'
 #' @details
 #' La única diferencia con [pkgdown::build_site()] es que te recuerda los pasos
@@ -11,7 +11,7 @@
 #' Al contrario que [ros_actions_pkgdown_branch()], esta acción se ejecuta por
 #' el usuario.
 #'
-#' @seealso [ros_actions_pkgdown_branch()], [`pkgdown::build_site()`]
+#' @seealso [ros_actions_pkgdown_branch()], [pkgdown::build_site()].
 #'
 #' @export
 #'
@@ -31,16 +31,19 @@ ros_build <- function(pkg = ".", ...) {
   }
 
   # Add lines to Rbuildignore
-  linesrbuild <- readLines(rbuildignore)
-  newlinesrbuild <-
-    unique(c(linesrbuild, "^\\.github$", "^docs$", "^_pkgdown\\.yml$"))
-  newlinesrbuild <- newlinesrbuild[newlinesrbuild != ""]
-  writeLines(newlinesrbuild, rbuildignore)
+  usethis::write_union(
+    rbuildignore,
+    c(
+      "^docs$", "^_pkgdown\\.yml$", "^_pkgdown\\.yaml$",
+      "^\\.github$", "^pkgdown$"
+    )
+  )
+
 
   sel <-
     menu(c("Yes", "No"),
       title = paste0(
-        "Have you included \n\ntemplate:\n  package: ",
+        "Have you included \n\ntemplate:\n  bootstrap: 5\n  package: ",
         "rostemplate\n\nin your _pkgdown.yml file?"
       )
     )

R/ros_gh_actions_croncheck.R

@@ -38,11 +38,13 @@ ros_actions_check_cron <-
     }
 
     # Add lines to Rbuildignore
-    linesrbuild <- readLines(rbuildignore)
-    newlinesrbuild <-
-      unique(c(linesrbuild, "^\\.github$", "^docs$", "^_pkgdown\\.yml$"))
-    newlinesrbuild <- newlinesrbuild[newlinesrbuild != ""]
-    writeLines(newlinesrbuild, rbuildignore)
+    usethis::write_union(
+      rbuildignore,
+      c(
+        "^docs$", "^_pkgdown\\.yml$", "^_pkgdown\\.yaml$",
+        "^\\.github$", "^pkgdown$"
+      )
+    )
 
     # Check gitignore
 
@@ -52,11 +54,10 @@ ros_actions_check_cron <-
     }
 
     # Add lines to gitignore
-    lines <- readLines(gitignore)
-    newlines <-
-      unique(c(lines, "*.html", "R-version", "depends.Rds"))
-    newlines <- newlines[newlines != ""]
-    writeLines(newlines, gitignore)
+    usethis::write_union(
+      gitignore,
+      c("*.html", "R-version", "depends.Rds")
+    )
 
     # Get action file
     filepath <-

R/ros_pals.R

@@ -1,6 +1,6 @@
-#' rOpenSpain paletas de color
+#' Paletas de colores de **rOpenSpain**
 #'
-#' Paletas de colores basadas en el tema de rOpenSpain
+#' Paletas de colores basadas en el tema de **rOpenSpain**.
 #'
 #' @family ros_plot
 #'

README.Rmd

@@ -27,15 +27,15 @@ status](https://github.com/ropenspain/rostemplate/workflows/R-CMD-check/badge.sv
 
 <!-- badges: end -->
 
-Esta librería es una plantilla `pkgdown` adaptada al sitio web de
+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.
+**rOpenSpain**. Por favor, no la uses para otros paquetes.
 
 ## Introducción
 
-Este paquete proporciona una plantilla de `pkgdown` adaptada a la empleada por
+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://bootstrapious.com/p/universal-business-e-commerce-template)
@@ -50,6 +50,7 @@ siguientes líneas:
 
 ``` yaml
 template:
+  bootstrap: 5
   package: rostemplate
   # No pongas la siguiente línea!
   default_assets: false
@@ -72,7 +73,8 @@ líneas:
 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.
+`css`, etc. basados en el paquete de **R** para el que se está generando el
+sitio.
 
 ### Con GitHub actions - CI
 
@@ -90,9 +92,9 @@ 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`
+#### Alternativa usando las funciones de rostemplate
 
-Aunque el uso del paquete `rostemplate` en si no es necesario con GitHub
+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
@@ -139,8 +141,8 @@ Más información sobre cómo adaptar los *triggers* de la acción
 
 ### RStudio - manual
 
-El sitio estático se puede generar igualmente desde una sesión local en RStudio.
-Para ello, es necesario instalar este paquete:
+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",