Merge pull request #43 from dieghernan/main

Improve docs

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.5
+version: 0.3.5.9000
 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.5
+  version: 0.3.5.9000
   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
@@ -136,7 +136,7 @@ references:
     name-particle: van den
     orcid: https://orcid.org/0000-0002-9335-7468
   year: '2024'
-  version: '>= 3.3.0'
+  version: '>= 3.5.0'
 - type: software
   title: readr
   abstract: 'readr: Read Rectangular Text Data'

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: tidyBdE
 Title: Download Data from Bank of Spain
-Version: 0.3.5
+Version: 0.3.5.9000
 Authors@R: 
     person("Diego", "H. Herrero", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-8457-4658", affiliation = "rOpenSpain"))
@@ -18,7 +18,7 @@ Depends:
     R (>= 3.6.0)
 Imports: 
     dplyr (>= 0.7.0),
-    ggplot2 (>= 3.3.0),
+    ggplot2 (>= 3.5.0),
     readr (>= 1.0.0),
     scales (>= 1.1.0),
     tibble (>= 3.0.0),
@@ -33,7 +33,7 @@ VignetteBuilder:
     knitr
 Config/Needs/coverage: covr
 Config/Needs/website: reactable, styler, tidyverse,
-    ropenspain/rostemplate, devtools
+    ropenspain/rostemplate, devtools, cpp11, remotes
 Config/testthat/edition: 3
 Config/testthat/parallel: true
 Copyright: See file inst/COPYRIGHTS

NEWS.md

@@ -1,3 +1,8 @@
+# tidyBdE (development version)
+
+-   Adapt `scale_color_bde_d()` and friends to **ggplot2** 3.5.0. Also
+    expose the `guide` argument instead of hard-coding it. 
+
 # tidyBdE 0.3.5
 
 Mostly changes on the color functions:

R/bde_check_access.R

@@ -1,7 +1,7 @@
 #' Check access to BdE
 #'
 #' @description
-#' Check if R has access to resources at
+#' Check if **R** has access to resources at
 #' <https://www.bde.es/webbe/en/estadisticas/recursos/descargas-completas.html>.
 #'
 #' @return a logical.

R/catalogs.R

@@ -9,7 +9,7 @@
 #'
 #' @encoding UTF-8
 #'
-#' @return A [tibble][tibble::tibble].
+#' @return A [`tibble`][tibble::tibble] object.
 #'
 #' @source
 #' [Time-series bulk data
@@ -301,7 +301,7 @@ bde_catalog_update <- function(catalog = c("ALL", "BE", "SI", "TC", "TI", "PB"),
 #'
 #' @family  catalog
 #'
-#' @return A [tibble][tibble::tibble] with the results of the query.
+#' @return A [`tibble`][tibble::tibble] object with the results of the query.
 #'
 #' @param pattern [`regex`][base::regex]  pattern to search See **Details**
 #'   and **Examples**.

R/scales.R

@@ -1,4 +1,4 @@
-#' BdE scales for \CRANpkg{ggplot2}.
+#' BdE scales for \CRANpkg{ggplot2}
 #'
 #' @description
 #'
@@ -21,6 +21,7 @@
 #'   for details.
 #'
 #' @inheritParams bde_tidy_palettes
+#' @inheritParams ggplot2::continuous_scale
 #'
 #' @param ... Further arguments of [ggplot2::discrete_scale()] or
 #'   [ggplot2::continuous_scale()].
@@ -59,7 +60,6 @@ scale_color_bde_d <- function(
   ggplot2::discrete_scale(
     aesthetics = "color",
     palette = pal,
-    scale_name = palette,
     ...
   )
 }
@@ -84,7 +84,6 @@ scale_fill_bde_d <- function(
   ggplot2::discrete_scale(
     aesthetics = "fill",
     palette = pal,
-    scale_name = palette,
     ...
   )
 }
@@ -95,7 +94,7 @@ scale_fill_bde_d <- function(
 #' @export
 scale_color_bde_c <- function(
     palette = c("bde_rose_pal", "bde_vivid_pal", "bde_qual_pal"), alpha = NULL,
-    rev = FALSE, ...) {
+    rev = FALSE, guide = "colorbar", ...) {
   palette <- match.arg(palette)
 
 
@@ -115,9 +114,8 @@ scale_color_bde_c <- function(
   )
   ggplot2::continuous_scale(
     aesthetics = "color",
-    scale_name = palette,
     palette = scales::gradient_n_pal(cols),
-    guide = "colorbar",
+    guide = guide,
     ...
   )
 }
@@ -133,7 +131,7 @@ scale_colour_bde_c <- scale_color_bde_c
 #' @export
 scale_fill_bde_c <- function(
     palette = c("bde_rose_pal", "bde_vivid_pal", "bde_qual_pal"), alpha = NULL,
-    rev = FALSE, ...) {
+    rev = FALSE, guide = "colorbar", ...) {
   palette <- match.arg(palette)
 
 
@@ -153,9 +151,8 @@ scale_fill_bde_c <- function(
   )
   ggplot2::continuous_scale(
     aesthetics = "fill",
-    scale_name = palette,
     palette = scales::gradient_n_pal(cols),
-    guide = "colorbar",
+    guide = guide,
     ...
   )
 }

R/series.R

@@ -1,4 +1,4 @@
-#' Load a single BdE time-series.
+#' Load a single BdE time-series
 #'
 #' Load a single time-series provided by BdE.
 #'
@@ -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,

R/theme_tidybde.R

@@ -1,12 +1,12 @@
-#' BdE `ggplot2` theme
+#' BdE \CRANpkg{ggplot2} theme
 #'
 #' A custom \CRANpkg{ggplot2} theme based on the publications of BdE.
 #'
 #' @family bde_plot
 #'
 #' @export
 #'
-#' @return A [ggplot2::theme_classic()].
+#' @return A \CRANpkg{ggplot2} [`theme()`][ggplot2::theme_classic()].
 #'
 #' @inheritDotParams ggplot2::theme_classic
 #'

R/utils.R

@@ -6,7 +6,7 @@
 #'
 #' @family utils
 #'
-#' @return A class "Date" object.
+#' @return A [`Date`][as.Date()] object.
 #'
 #' @seealso [as.Date()]
 #'

README.md

@@ -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.5},
+      version = {0.3.5.9000},
       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,7 +8,7 @@
   "codeRepository": "https://github.com/rOpenSpain/tidyBdE",
   "issueTracker": "https://github.com/rOpenSpain/tidyBdE/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.3.5",
+  "version": "0.3.5.9000",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -123,7 +123,7 @@
       "@type": "SoftwareApplication",
       "identifier": "ggplot2",
       "name": "ggplot2",
-      "version": ">= 3.3.0",
+      "version": ">= 3.5.0",
       "provider": {
         "@id": "https://cran.r-project.org",
         "@type": "Organization",
@@ -192,7 +192,7 @@
   },
   "applicationCategory": "Macroeconomics",
   "isPartOf": "https://ropenspain.es/",
-  "fileSize": "288.623KB",
+  "fileSize": "289.079KB",
   "citation": [
     {
       "@type": "SoftwareSourceCode",

inst/schemaorg.json

@@ -29,7 +29,7 @@
         "url": "https://cran.r-project.org"
       },
       "runtimePlatform": "R version 4.3.3 (2024-02-29 ucrt)",
-      "version": "0.3.5"
+      "version": "0.3.5.9000"
     },
     {
       "id": "https://doi.org/10.5281/zenodo.4673496",