Rename funs

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

@@ -38,5 +38,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, clean = FALSE)'
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE, clean = TRUE)'
 

.github/workflows/wipe-cache.yaml

@@ -1,7 +1,8 @@
 name: Clear GHA caches manually
 on:
   workflow_dispatch:
-
+  schedule:
+    - cron:  '0 22 2 * *'
 jobs:
   cache-clear:
     runs-on: ubuntu-latest

CITATION.cff

@@ -8,7 +8,7 @@ message: 'To cite package "tidyBdE" in publications use:'
 type: software
 license: GPL-3.0-or-later
 title: 'tidyBdE: Download Data from Bank of Spain'
-version: 0.3.4.9000
+version: 0.3.5
 doi: 10.5281/zenodo.4673496
 abstract: Tools to download data series from 'Banco de España' ('BdE') on 'tibble'
   format. 'Banco de España' is the national central bank and, within the framework
@@ -32,7 +32,7 @@ preferred-citation:
     affiliation: rOpenSpain
   doi: 10.5281/zenodo.4673496
   year: '2024'
-  version: 0.3.4.9000
+  version: 0.3.5
   url: https://ropenspain.github.io/tidyBdE/
   abstract: Tools to download data series from Banco de España (BdE) on tibble format.
     Banco de España is the national central bank and, within the framework of the

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: tidyBdE
 Title: Download Data from Bank of Spain
-Version: 0.3.4.9000
+Version: 0.3.5
 Authors@R: 
     person("Diego", "H. Herrero", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-8457-4658", affiliation = "rOpenSpain"))
@@ -32,7 +32,8 @@ Suggests:
 VignetteBuilder: 
     knitr
 Config/Needs/coverage: covr
-Config/Needs/website: reactable, styler, tidyverse, ropenspain/rostemplate
+Config/Needs/website: reactable, styler, tidyverse,
+    ropenspain/rostemplate, devtools
 Config/testthat/edition: 3
 Config/testthat/parallel: true
 Copyright: See file inst/COPYRIGHTS

NAMESPACE

@@ -14,11 +14,11 @@ export(bde_ind_ibex_daily)
 export(bde_ind_ibex_monthly)
 export(bde_ind_population)
 export(bde_ind_unemployment_rate)
-export(bde_palettes)
 export(bde_parse_dates)
 export(bde_rose_pal)
 export(bde_series_full_load)
 export(bde_series_load)
+export(bde_tidy_palettes)
 export(bde_vivid_pal)
 export(scale_color_bde_c)
 export(scale_color_bde_d)

NEWS.md

@@ -1,12 +1,13 @@
-# tidyBdE (development version)
+# tidyBdE 0.3.5
 
 Mostly changes on the color functions:
 
 -   `bde_vivid_pal()` and `bde_rose_pal()` have been superseded. Use the new
-    function `bde_palettes()` instead.
--   `scale_color_bde_d()` and friends leverage now on `bde_palettes()`, and
+    function `bde_tidy_palettes()` instead.
+-   `scale_color_bde_d()` and friends leverage now on `bde_tidy_palettes()`, and
     these functions gain two new arguments: `alpha` y `rev`.
 -   Update and review documentation.
+-   New palette named `bde_qual_pal`.
 
 # tidyBdE 0.3.4
 

R/bde_palettes.R → R/bde_tidy_palettes.R

@@ -20,12 +20,21 @@
 #' @examples
 #'
 #' # BdE vivid pal
-#' scales::show_col(bde_palettes(palette = "bde_vivid_pal"), labels = FALSE)
+#' scales::show_col(bde_tidy_palettes(palette = "bde_vivid_pal"),
+#'   labels = FALSE
+#' )
 #'
 #' # BdE rose pal
-#' scales::show_col(bde_palettes(palette = "bde_rose_pal"), labels = FALSE)
-bde_palettes <- function(n = 6, palette = c("bde_vivid_pal", "bde_rose_pal"),
-                         alpha = NULL, rev = FALSE) {
+#' scales::show_col(bde_tidy_palettes(palette = "bde_rose_pal"), labels = FALSE)
+#'
+#' # BdE qual pal
+#' scales::show_col(bde_tidy_palettes(palette = "bde_qual_pal"), labels = FALSE)
+bde_tidy_palettes <- function(n = 6,
+                              palette = c(
+                                "bde_vivid_pal", "bde_rose_pal",
+                                "bde_qual_pal"
+                              ),
+                              alpha = NULL, rev = FALSE) {
   palette <- match.arg(palette)
 
   cols <- switch(palette,
@@ -36,6 +45,10 @@ bde_palettes <- function(n = 6, palette = c("bde_vivid_pal", "bde_rose_pal"),
     "bde_rose_pal" = c(
       "#b7365c", "#cb6e8a", "#db9aad",
       "#0a50a1", "#5385bd", "#89AEDA"
+    ),
+    "bde_qual_pal" = c(
+      "#b55b4a", "#2e76bc", "#fece64",
+      "#68be57", "#858788", "#f9b4af"
     )
   )
 

R/scales.R

@@ -17,10 +17,10 @@
 #'
 #' @name scales_bde
 #'
-#' @param palette Name of the BdE palette to apply. One of `"bde_vivid_pal"`,
-#'   `"bde_rose_pal"`. See [bde_palettes()] for details.
+#' @param palette Name of the BdE palette to apply. See [bde_tidy_palettes()]
+#'   for details.
 #'
-#' @inheritParams bde_palettes
+#' @inheritParams bde_tidy_palettes
 #'
 #' @param ... Further arguments of [ggplot2::discrete_scale()] or
 #'   [ggplot2::continuous_scale()].
@@ -45,14 +45,15 @@
 #'
 #' ggplot(txsamp, aes(x = sales, y = median)) +
 #'   geom_point(aes(colour = city)) +
-#'   scale_color_bde_d("bde_rose_pal") +
+#'   scale_color_bde_d("bde_qual_pal") +
 #'   theme_minimal()
 #'
-scale_color_bde_d <- function(palette = c("bde_vivid_pal", "bde_rose_pal"),
-                              alpha = NULL, rev = FALSE, ...) {
+scale_color_bde_d <- function(
+    palette = c("bde_vivid_pal", "bde_rose_pal", "bde_qual_pal"), alpha = NULL,
+    rev = FALSE, ...) {
   palette <- match.arg(palette)
 
-  cols_v <- bde_palettes(palette = palette, alpha = alpha, rev = rev)
+  cols_v <- bde_tidy_palettes(palette = palette, alpha = alpha, rev = rev)
   pal <- scales::manual_pal(cols_v)
 
   ggplot2::discrete_scale(
@@ -72,11 +73,12 @@ scale_colour_bde_d <- scale_color_bde_d
 #' @rdname scales_bde
 #' @name scales_bde
 #' @export
-scale_fill_bde_d <- function(palette = c("bde_vivid_pal", "bde_rose_pal"),
-                             alpha = NULL, rev = FALSE, ...) {
+scale_fill_bde_d <- function(
+    palette = c("bde_vivid_pal", "bde_rose_pal", "bde_qual_pal"), alpha = NULL,
+    rev = FALSE, ...) {
   palette <- match.arg(palette)
 
-  cols_v <- bde_palettes(palette = palette, alpha = alpha, rev = rev)
+  cols_v <- bde_tidy_palettes(palette = palette, alpha = alpha, rev = rev)
   pal <- scales::manual_pal(cols_v)
 
   ggplot2::discrete_scale(
@@ -91,17 +93,22 @@ scale_fill_bde_d <- function(palette = c("bde_vivid_pal", "bde_rose_pal"),
 #' @rdname scales_bde
 #' @name scales_bde
 #' @export
-scale_color_bde_c <- function(palette = c("bde_rose_pal", "bde_vivid_pal"),
-                              alpha = NULL, rev = FALSE, ...) {
+scale_color_bde_c <- function(
+    palette = c("bde_rose_pal", "bde_vivid_pal", "bde_qual_pal"), alpha = NULL,
+    rev = FALSE, ...) {
   palette <- match.arg(palette)
 
 
   cols <- switch(palette,
-    "bde_vivid_pal" = bde_palettes(6, "bde_vivid_pal",
+    "bde_vivid_pal" = bde_tidy_palettes(6, "bde_vivid_pal",
       alpha = alpha,
       rev = rev
     ),
-    "bde_rose_pal" = bde_palettes(6, "bde_rose_pal",
+    "bde_qual_pal" = bde_tidy_palettes(6, "bde_qual_pal",
+      alpha = alpha,
+      rev = rev
+    ),
+    "bde_rose_pal" = bde_tidy_palettes(6, "bde_rose_pal",
       alpha = alpha,
       rev = rev
     )[c(1, 2, 3, 6, 5, 4)]
@@ -124,17 +131,22 @@ scale_colour_bde_c <- scale_color_bde_c
 #' @rdname scales_bde
 #' @name scales_bde
 #' @export
-scale_fill_bde_c <- function(palette = c("bde_rose_pal", "bde_vivid_pal"),
-                             alpha = NULL, rev = FALSE, ...) {
+scale_fill_bde_c <- function(
+    palette = c("bde_rose_pal", "bde_vivid_pal", "bde_qual_pal"), alpha = NULL,
+    rev = FALSE, ...) {
   palette <- match.arg(palette)
 
 
   cols <- switch(palette,
-    "bde_vivid_pal" = bde_palettes(6, "bde_vivid_pal",
+    "bde_vivid_pal" = bde_tidy_palettes(6, "bde_vivid_pal",
+      alpha = alpha,
+      rev = rev
+    ),
+    "bde_qual_pal" = bde_tidy_palettes(6, "bde_qual_pal",
       alpha = alpha,
       rev = rev
     ),
-    "bde_rose_pal" = bde_palettes(6, "bde_rose_pal",
+    "bde_rose_pal" = bde_tidy_palettes(6, "bde_rose_pal",
       alpha = alpha,
       rev = rev
     )[c(1, 2, 3, 6, 5, 4)]

R/series.R

@@ -24,7 +24,7 @@
 #'
 #'
 #' @return
-#' A [tibble][tibble::tibble] with a field "Date" and :
+#' A [tibble][tibble::tibble] with a field `Date` and :
 #' - With `out_format = "wide"` each series is presented in a separate
 #'   column with the name defined by `series_label`.
 #' - With `out_format = "long"` the tibble would have two more columns,
@@ -291,7 +291,7 @@ bde_series_load <- function(series_code, series_label = NULL,
 #' @param extract_metadata Logical `TRUE/FALSE`. On `TRUE` the output is the
 #'   metadata of the requested series.
 #'
-#' @return A [tibble][tibble::tibble] with a field "Date" and the alias of the
+#' @return A [tibble][tibble::tibble] with a field `Date` and the alias of the
 #' fields series as described on the catalogs. See [bde_catalog_load()].
 #'
 #' @note

R/superseded.R

@@ -3,7 +3,8 @@
 #' @description
 #' `r lifecycle::badge('superseded')`
 #'
-#' These functions have been superseded, see [bde_palettes()] as a replacement.
+#' These functions have been superseded, see [bde_tidy_palettes()] as a
+#' replacement.
 #'
 #' Custom palettes based on the publications of BdE.
 #'
@@ -29,7 +30,7 @@ bde_vivid_pal <- function(...) {
   if (requireNamespace("lifecycle", quietly = TRUE)) {
     lifecycle::deprecate_soft(
       "0.3.5", "bde_vivid_pal()",
-      "bde_palettes()"
+      "bde_tidy_palettes()"
     )
   }
 
@@ -44,7 +45,7 @@ bde_rose_pal <- function(...) {
   if (requireNamespace("lifecycle", quietly = TRUE)) {
     lifecycle::deprecate_soft(
       "0.3.5", "bde_rose_pal()",
-      "bde_palettes()"
+      "bde_tidy_palettes()"
     )
   }
   pal <- c("#b7365c", "#cb6e8a", "#db9aad", "#0a50a1", "#5385bd", "#89AEDA")

R/theme_tidybde.R

@@ -38,7 +38,7 @@
 #'   names(series_TC_pivot) <- c("x", "y")
 #'
 #'   ggplot(series_TC_pivot, aes(x = x, y = y)) +
-#'     geom_line(linewidth = 0.8, color = bde_palettes(n = 1)) +
+#'     geom_line(linewidth = 0.8, color = bde_tidy_palettes(n = 1)) +
 #'     labs(
 #'       title = "Title",
 #'       subtitle = "Some metric",

README.Rmd

@@ -126,8 +126,8 @@ BdE:
 
 ```{r chart, fig.asp=0.7}
 ggplot(time_series, aes(x = Date, y = EUR_GBP_XR)) +
-  geom_line(colour = bde_palettes(n = 1)) +
-  geom_smooth(method = "gam", colour = bde_palettes(n = 2)[2]) +
+  geom_line(colour = bde_tidy_palettes(n = 1)) +
+  geom_smooth(method = "gam", colour = bde_tidy_palettes(n = 2)[2]) +
   labs(
     title = "EUR/GBP Exchange Rate (2010-2020)",
     subtitle = "%",

README.md

@@ -116,8 +116,8 @@ publications of BdE:
 
 ``` r
 ggplot(time_series, aes(x = Date, y = EUR_GBP_XR)) +
-  geom_line(colour = bde_palettes(n = 1)) +
-  geom_smooth(method = "gam", colour = bde_palettes(n = 2)[2]) +
+  geom_line(colour = bde_tidy_palettes(n = 1)) +
+  geom_smooth(method = "gam", colour = bde_tidy_palettes(n = 2)[2]) +
   labs(
     title = "EUR/GBP Exchange Rate (2010-2020)",
     subtitle = "%",
@@ -231,7 +231,7 @@ A BibTeX entry for LaTeX users is
       doi = {10.5281/zenodo.4673496},
       author = {Diego {H. Herrero}},
       year = {2024},
-      version = {0.3.4.9000},
+      version = {0.3.5},
       url = {https://ropenspain.github.io/tidyBdE/},
       abstract = {Tools to download data series from Banco de España (BdE) on tibble format. Banco de España is the national central bank and, within the framework of the Single Supervisory Mechanism (SSM), the supervisor of the Spanish banking system along with the European Central Bank. This package is in no way sponsored endorsed or administered by Banco de España.},
     }

codemeta.json

@@ -8,13 +8,13 @@
   "codeRepository": "https://github.com/rOpenSpain/tidyBdE",
   "issueTracker": "https://github.com/rOpenSpain/tidyBdE/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.3.4.9000",
+  "version": "0.3.5",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
     "url": "https://r-project.org"
   },
-  "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)",
+  "runtimePlatform": "R version 4.3.2 (2023-10-31)",
   "provider": {
     "@id": "https://cran.r-project.org",
     "@type": "Organization",
@@ -192,7 +192,7 @@
   },
   "applicationCategory": "Macroeconomics",
   "isPartOf": "https://ropenspain.es/",
-  "fileSize": "273.717KB",
+  "fileSize": "273.083KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",

inst/schemaorg.json

@@ -28,8 +28,8 @@
         "name": "Comprehensive R Archive Network (CRAN)",
         "url": "https://cran.r-project.org"
       },
-      "runtimePlatform": "R version 4.3.2 (2023-10-31 ucrt)",
-      "version": "0.3.4.9000"
+      "runtimePlatform": "R version 4.3.2 (2023-10-31)",
+      "version": "0.3.5"
     },
     {
       "id": "https://doi.org/10.5281/zenodo.4673496",