Merge pull request #76 from rOpenGov/devdoc

Improve docs

CITATION.cff

@@ -8,7 +8,7 @@ message: 'To cite package "giscoR" in publications use:'
 type: software
 license: GPL-3.0-only
 title: 'giscoR: Download Map Data from GISCO API - Eurostat'
-version: 0.4.0
+version: 0.4.0.9000
 doi: 10.5281/zenodo.4317946
 abstract: Tools to download data from the GISCO (Geographic Information System of
   the Commission) Eurostat database <https://ec.europa.eu/eurostat/web/gisco>. Global
@@ -30,8 +30,8 @@ preferred-citation:
     orcid: https://orcid.org/0000-0001-8457-4658
     affiliation: rOpenGov
   doi: 10.5281/zenodo.4317946
-  year: '2023'
-  version: 0.4.0
+  year: '2024'
+  version: 0.4.0.9000
   url: https://ropengov.github.io/giscoR/
   abstract: Tools to download data from the GISCO (Geographic Information System of
     the Commission) Eurostat database <https://ec.europa.eu/eurostat/web/gisco>. Global
@@ -69,7 +69,7 @@ references:
   - name: R Core Team
   location:
     name: Vienna, Austria
-  year: '2023'
+  year: '2024'
   institution:
     name: R Foundation for Statistical Computing
   version: '>= 3.6.0'
@@ -84,7 +84,7 @@ references:
     given-names: Vincent
     email: [email protected]
     orcid: https://orcid.org/0000-0003-2042-7063
-  year: '2023'
+  year: '2024'
   version: '>= 1.2.0'
 - type: software
   title: geojsonsf
@@ -96,7 +96,7 @@ references:
   - family-names: Cooley
     given-names: David
     email: [email protected]
-  year: '2023'
+  year: '2024'
   version: '>= 2.0.0'
 - type: software
   title: httr
@@ -108,7 +108,7 @@ references:
   - family-names: Wickham
     given-names: Hadley
     email: [email protected]
-  year: '2023'
+  year: '2024'
 - type: software
   title: rappdirs
   abstract: 'rappdirs: Application Directories: Determine Where to Save Data, Caches,
@@ -123,7 +123,7 @@ references:
     given-names: Trent
   - family-names: Davis
     given-names: Trevor
-  year: '2023'
+  year: '2024'
   version: '>= 0.3.0'
 - type: software
   title: sf
@@ -136,7 +136,7 @@ references:
     given-names: Edzer
     email: [email protected]
     orcid: https://orcid.org/0000-0001-8049-7069
-  year: '2023'
+  year: '2024'
   version: '>= 0.9.0'
 - type: software
   title: utils
@@ -146,7 +146,7 @@ references:
   - name: R Core Team
   location:
     name: Vienna, Austria
-  year: '2023'
+  year: '2024'
   institution:
     name: R Foundation for Statistical Computing
 - type: software
@@ -166,7 +166,7 @@ references:
     given-names: Markus
   - family-names: Biecek
     given-names: Przemyslaw
-  year: '2023'
+  year: '2024'
 - type: software
   title: ggplot2
   abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
@@ -201,7 +201,7 @@ references:
   - family-names: Dunnington
     given-names: Dewey
     orcid: https://orcid.org/0000-0002-9415-4582
-  year: '2023'
+  year: '2024'
   version: '>= 3.0.0'
 - type: software
   title: knitr
@@ -214,7 +214,7 @@ references:
     given-names: Yihui
     email: [email protected]
     orcid: https://orcid.org/0000-0003-0645-5666
-  year: '2023'
+  year: '2024'
 - type: software
   title: lwgeom
   abstract: 'lwgeom: Bindings to Selected ''liblwgeom'' Functions for Simple Features'
@@ -226,7 +226,7 @@ references:
     given-names: Edzer
     email: [email protected]
     orcid: https://orcid.org/0000-0001-8049-7069
-  year: '2023'
+  year: '2024'
   version: '>= 0.2-2'
 - type: software
   title: rmarkdown
@@ -270,7 +270,7 @@ references:
     given-names: Richard
     email: [email protected]
     orcid: https://orcid.org/0000-0003-3925-190X
-  year: '2023'
+  year: '2024'
 - type: software
   title: testthat
   abstract: 'testthat: Unit Testing for R'
@@ -281,5 +281,5 @@ references:
   - family-names: Wickham
     given-names: Hadley
     email: [email protected]
-  year: '2023'
+  year: '2024'
   version: '>= 3.0.0'

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: giscoR
 Title: Download Map Data from GISCO API - Eurostat
-Version: 0.4.0
+Version: 0.4.0.9000
 Authors@R: c(
     person("Diego", "Hernangómez", , "[email protected]", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0001-8457-4658", affiliation = "rOpenGov")),

NEWS.md

@@ -1,3 +1,8 @@
+# giscoR (development version)
+
+-   Improve documentation, stating where the parameters `country` and `region`
+    applies (#50, #75)
+
 # giscoR 0.4.0
 
 -   `gisco_get_nuts()`: Add an additional `geo` column (identical to `NUTS_ID`)

R/data.R

@@ -10,7 +10,7 @@
 #'
 #' @format A data frame
 #'
-#' @details This dataframe is used to check the validity of the API calls.
+#' @details This data frame is used to check the validity of the API calls.
 #'
 #' @source GISCO API `datasets.json`.
 #' @keywords internal
@@ -19,14 +19,14 @@
 #' data(gisco_db)
 NULL
 
-#' World countries `POLYGON` object
+#' World countries `POLYGON` \CRANpkg{sf} object
 #'
 #' @family dataset
 #'
 #' @name gisco_countries
 #'
-#' @description A `sf` object including all
-#' countries as provided by GISCO (2016 version).
+#' @description A \CRANpkg{sf} object including all countries as provided by
+#' GISCO (2016 version).
 #'
 #' @format
 #' A `MULTIPOLYGON` data frame (resolution: 1:20million, EPSG:4326) object
@@ -64,14 +64,14 @@ NULL
 
 #' World coastal lines `POLYGON` object
 #'
-#' A `sf` object as provided by GISCO (2016 version).
+#' A \CRANpkg{sf} object as provided by GISCO (2016 version).
 #'
 #' @family dataset
 #'
 #' @name gisco_coastallines
 #'
 #' @format
-#' A `POLYGON` data frame (resolution: 1:20million, EPSG:4326) object with
+#' A `POLYGON` \CRANpkg{sf} object (resolution: 1:20million, EPSG:4326) with
 #' 3 variables:
 #' \describe{
 #'   \item{COAS_ID}{Coast ID}
@@ -113,7 +113,8 @@ NULL
 
 #' All NUTS `POLYGON` object
 #'
-#' A `sf` object including all NUTS levels as provided by GISCO (2016 version).
+#' A \CRANpkg{sf} object including all NUTS levels as provided by GISCO
+#' (2016 version).
 #'
 #' @family dataset
 #'
@@ -186,16 +187,16 @@ NULL
 NULL
 
 
-#' Dataframe with different country code schemes and world regions
+#' Data frame with different country code schemes and world regions
 #'
 #' @name gisco_countrycode
 #'
 #' @family dataset
 #'
 #' @description
-#' A dataframe containing conversions between different country
+#' A data frame containing conversions between different country
 #' code schemes (Eurostat/ISO2 and 3) as well as geographic regions as
-#' provided by the World Bank and the UN (M49). This dataset
+#' provided by the World Bank and the UN (M49). This data set
 #' is extracted from \CRANpkg{countrycode} package.
 #'
 #' @format