Package review 2 (#146)

* Dev generals pkg review (#125) * All comments for general changes have been implemented. * Automatic readme update --------- Co-authored-by: GitHub Action <[email protected]> * Modify download_population_projections.R file (#126) Now, dynamic sized data.frame is a list. * Revert "Dev generals pkg review (#125)" (#129) This reverts commit ff9c60f. * Revert "Modify download_population_projections.R file (#126)" (#130) This reverts commit 34d99be. * Dev generals pkg review (#133) * Comments from full package review Vignettes & pkgdown (#134) * Modify download_population_projections.R file (#132) * Update climate comments from package review 2 (#128) * Update tests and snapshots * Separate dictionaryfunctions Separate dictionaries and climate tags list * Fix minimum temperature errors * Update vignettes * Change dynamic sized data.frame Also, include the initial date for climate data consultation and separate climate assertion function * Change list formatting * Replacement of dplyr::do (#135) * Modification of dplyr::do * Delete utils-pipe.R * fixed errors * Update NAMESPACE * fixed errors * add dplyr:: before calling the function * Update download_geospatial.R * Updates of lint and license (#137) * Updated lint-changed-files.yml and LICENSE.md * Update .lintr * Dev climate pkg rev 2 (#136) * Update tests and snapshots * Separate dictionaryfunctions Separate dictionaries and climate tags list * Fix minimum temperature errors * Update vignettes * Change dynamic sized data.frame Also, include the initial date for climate data consultation and separate climate assertion function * Change list formatting * Update download_geospatial.R * Enhance divipola (#138) As a response to comments in #115 , we have: - Removed dynamic sized vectors - Extract functions from loops (when possible) - Remove unnecessary for loops - Allow consultation of municipalities codes from one unique department with multiple municipalities - Avoid code repetition by creating an auxiliary function * Update tests comments (#139) * Update tests comments Add comments to tests explaining what us being tested #121 * Commit with styler * Dev httr rem (#141) * Remove httr2 and readr Replaced the usage of these libraries with utils read functions * Update CITATION.cff * Update snapshots * Update Climate download (#144) * Dev standard syntax (#143) * Dev dictionaries local (#145) * Changes to have dictionaries locally, not in the server. * Commit with styler * more changes * climate changes * fix test * R files for files associated to dictionaries * Commit with styler * modify .R files * update tests * Update _pkgdown.yml * other update in _pkgdown.yml * more changes * more updates * Add dictionaries and climate tags Add geospatial dictionaries and climate tags in both Spanish and English * Small corrections on data * changes to have dictionaries and datasets description files in english and spanish, locally * commit with styler * man changes * fixed errors * fixed errors * moore fixed * spelling errros fixed * changes * modifications in functions * more updates * changes with styler * fixed issues * changes * updates * updates * update climate_tags function and file * updates * Fix ASCII characters in data * Update snapshots * Update documentation.R * updates in functions * commit with styler * fix errors * look upp update * Update config.yaml --------- Co-authored-by: jd-otero <[email protected]> * Update DESCRIPTION * Update .lintr * Update lintr * Update config.yaml * Commit with styler * Update CITATION.cff * Update DESCRIPTION * Update CITATION.cff * Update documentation.R * Update documentation.R * Update lintr * Update lint-changed-files.yaml * Update .lintr * fixed lintr errors * fixed lintr errors * fixed lintr errors * fixed lintr errors * lintr errors * lintr errors * fixed lintr errors * fixed lintr errors * update look_up * fixed look_up lintr errrors * fixed lintr * fixed lintr errrors * fixed more lintr errors --------- Co-authored-by: M. Camila Tavera-Cifuentes <[email protected]> Co-authored-by: GitHub Action <[email protected]> Co-authored-by: macataci <[email protected]>
epiverse-trace · Jul 30, 2024 · 876f7bd · 876f7bd
1 parent 261c4d8
commit 876f7bd
Show file tree

Hide file tree

Showing 92 changed files with 4,038 additions and 3,812 deletions.
diff --git a/.github/workflows/lint-changed-files.yml → .github/workflows/lint-changed-files.yaml b/.github/workflows/lint-changed-files.yml → .github/workflows/lint-changed-files.yaml
diff --git a/.lintr b/.lintr
@@ -1,20 +1,39 @@
-linters: linters_with_tags(
-    tags = NULL, # include all linters
+linters: all_linters(
+    packages = c("lintr", "etdev"),
+    pipe_consistency_linter(pipe = "%>%"),
     object_name_linter = NULL,
-    undesirable_function_linter = NULL,
     implicit_integer_linter = NULL,
     extraction_operator_linter = NULL,
     todo_comment_linter = NULL,
+    library_call_linter = NULL,
+    undesirable_function_linter(
+      modify_defaults(
+        default_undesirable_functions,
+        citEntry = "use the more modern bibentry() function",
+        library = NULL # too many false positive in too many files
+      )
+    ),
     function_argument_linter = NULL,
     indentation_linter = NULL, # unstable as of lintr 3.1.0
     # Use minimum R declared in DESCRIPTION or fall back to current R version.
     # Install etdev package from https://github.com/epiverse-trace/etdev
     backport_linter(if (length(x <- etdev::extract_min_r_version())) x else getRversion())
   )
 exclusions: list(
-    "tests/testthat.R" = list(unused_import_linter = Inf),
+    "tests/testthat.R" = list(
+      unused_import_linter = Inf
+    ),
+    "tests" = list(
+      undesirable_function_linter = Inf
+    ),
     "data-raw" = list(
       missing_package_linter = Inf,
       namespace_linter = Inf
-    )
+    ),
+    # RcppExports.R is auto-generated and will not pass many linters. In
+    # particular, it can create very long lines.
+    "R/RcppExports.R",
+    # R/stanmodels.R is auto-generated and will not pass many linters. In
+    # particular, it uses `sapply()`.
+    "R/stanmodels.R"
   )
diff --git a/CITATION.cff b/CITATION.cff
@@ -8,34 +8,26 @@ message: 'To cite package "ColOpenData" in publications use:'
 type: software
 license: MIT
 title: 'ColOpenData: Colombian Open Data Download and Wrangling'
-version: 0.1.0
+version: 0.2.0
 abstract: ColOpenData is a package that acquires and wrangles Colombian socioeconomic,
-  geospatial and climate data. It solves the problem of Colombian data being issued
-  in different web pages and sources by using functions that allow the user to select
-  the desired database and download it without having to do the exhausting acquisition
-  process.
+  geospatial, population and climate data. It solves the problem of Colombian data
+  being issued in different web pages and sources by using functions that allow the
+  user to select the desired database and download it without having to do the exhausting
+  acquisition process.
 authors:
 - family-names: Tavera-Cifuentes
-  given-names: M. Camila
+  given-names: Maria Camila
   email: [email protected]
   orcid: https://orcid.org/0009-0007-1610-4583
 - family-names: Otero
   given-names: Julian
   email: [email protected]
   orcid: https://orcid.org/0009-0006-0429-7747
-- family-names: Umana
-  given-names: Juan D.
-  email: [email protected]
-  orcid: https://orcid.org/0000-0003-0316-6164
-- family-names: Montenegro-Torres
-  given-names: Juan
-  email: [email protected]
-  orcid: https://orcid.org/0000-0003-2755-4743
 repository-code: https://github.com/epiverse-trace/ColOpenData
 url: https://epiverse-trace.github.io/ColOpenData/
 contact:
 - family-names: Tavera-Cifuentes
-  given-names: M. Camila
+  given-names: Maria Camila
   email: [email protected]
   orcid: https://orcid.org/0009-0007-1610-4583
 keywords:
@@ -70,6 +62,7 @@ references:
     email: [email protected]
     orcid: https://orcid.org/0000-0001-9754-0393
   year: '2024'
+  doi: 10.32614/CRAN.package.checkmate
 - type: software
   title: config
   abstract: 'config: Manage Environment Specific Configuration Values'
@@ -81,6 +74,7 @@ references:
     given-names: JJ
     email: [email protected]
   year: '2024'
+  doi: 10.32614/CRAN.package.config
 - type: software
   title: dplyr
   abstract: 'dplyr: A Grammar of Data Manipulation'
@@ -105,17 +99,7 @@ references:
     email: [email protected]
     orcid: https://orcid.org/0000-0003-4777-038X
   year: '2024'
-- type: software
-  title: httr2
-  abstract: 'httr2: Perform HTTP Requests and Process the Responses'
-  notes: Imports
-  url: https://httr2.r-lib.org
-  repository: https://CRAN.R-project.org/package=httr2
-  authors:
-  - family-names: Wickham
-    given-names: Hadley
-    email: [email protected]
-  year: '2024'
+  doi: 10.32614/CRAN.package.dplyr
 - type: software
   title: magrittr
   abstract: 'magrittr: A Forward-Pipe Operator for R'
@@ -130,23 +114,7 @@ references:
     given-names: Hadley
     email: [email protected]
   year: '2024'
-- type: software
-  title: readr
-  abstract: 'readr: Read Rectangular Text Data'
-  notes: Imports
-  url: https://readr.tidyverse.org
-  repository: https://CRAN.R-project.org/package=readr
-  authors:
-  - family-names: Wickham
-    given-names: Hadley
-    email: [email protected]
-  - family-names: Hester
-    given-names: Jim
-  - family-names: Bryan
-    given-names: Jennifer
-    email: [email protected]
-    orcid: https://orcid.org/0000-0002-6983-2759
-  year: '2024'
+  doi: 10.32614/CRAN.package.magrittr
 - type: software
   title: rlang
   abstract: 'rlang: Functions for Base Types and Core R and ''Tidyverse'' Features'
@@ -161,6 +129,7 @@ references:
     given-names: Hadley
     email: [email protected]
   year: '2024'
+  doi: 10.32614/CRAN.package.rlang
 - type: software
   title: sf
   abstract: 'sf: Simple Features for R'
@@ -173,16 +142,7 @@ references:
     email: [email protected]
     orcid: https://orcid.org/0000-0001-8049-7069
   year: '2024'
-- type: software
-  title: utils
-  abstract: 'R: A Language and Environment for Statistical Computing'
-  notes: Imports
-  authors:
-  - name: R Core Team
-  institution:
-    name: R Foundation for Statistical Computing
-    address: Vienna, Austria
-  year: '2024'
+  doi: 10.32614/CRAN.package.sf
 - type: software
   title: stringdist
   abstract: 'stringdist: Approximate String Matching, Fuzzy Text Search, and String
@@ -197,6 +157,7 @@ references:
     email: [email protected]
     orcid: https://orcid.org/0000-0002-9807-4686
   year: '2024'
+  doi: 10.32614/CRAN.package.stringdist
 - type: software
   title: tidyr
   abstract: 'tidyr: Tidy Messy Data'
@@ -213,17 +174,18 @@ references:
   - family-names: Girlich
     given-names: Maximilian
   year: '2024'
+  doi: 10.32614/CRAN.package.tidyr
 - type: software
-  title: stringr
-  abstract: 'stringr: Simple, Consistent Wrappers for Common String Operations'
+  title: utils
+  abstract: 'R: A Language and Environment for Statistical Computing'
   notes: Imports
-  url: https://stringr.tidyverse.org
-  repository: https://CRAN.R-project.org/package=stringr
   authors:
-  - family-names: Wickham
-    given-names: Hadley
-    email: [email protected]
+  - name: R Core Team
+  institution:
+    name: R Foundation for Statistical Computing
+    address: Vienna, Austria
   year: '2024'
+  doi: 10.32614/CRAN.package.utils
 - type: software
   title: ggplot2
   abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
@@ -263,6 +225,7 @@ references:
     name-particle: van den
     orcid: https://orcid.org/0000-0002-9335-7468
   year: '2024'
+  doi: 10.32614/CRAN.package.ggplot2
 - type: software
   title: knitr
   abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
@@ -275,6 +238,7 @@ references:
     email: [email protected]
     orcid: https://orcid.org/0000-0003-0645-5666
   year: '2024'
+  doi: 10.32614/CRAN.package.knitr
 - type: software
   title: leaflet
   abstract: 'leaflet: Create Interactive Web Maps with the JavaScript ''Leaflet''
@@ -295,6 +259,7 @@ references:
   - family-names: Xie
     given-names: Yihui
   year: '2024'
+  doi: 10.32614/CRAN.package.leaflet
 - type: software
   title: rmarkdown
   abstract: 'rmarkdown: Dynamic Documents for R'
@@ -338,6 +303,7 @@ references:
     email: [email protected]
     orcid: https://orcid.org/0000-0003-3925-190X
   year: '2024'
+  doi: 10.32614/CRAN.package.rmarkdown
 - type: software
   title: spelling
   abstract: 'spelling: Tools for Spell Checking in R'
@@ -353,6 +319,7 @@ references:
     given-names: Jim
     email: [email protected]
   year: '2024'
+  doi: 10.32614/CRAN.package.spelling
 - type: software
   title: testthat
   abstract: 'testthat: Unit Testing for R'
@@ -364,5 +331,6 @@ references:
     given-names: Hadley
     email: [email protected]
   year: '2024'
+  doi: 10.32614/CRAN.package.testthat
   version: '>= 3.0.0'
 
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,29 +1,32 @@
 Package: ColOpenData
 Title: Colombian Open Data Download and Wrangling
-Version: 0.1.0
+Version: 0.2.0
 Authors@R: c(
-    person("M. Camila", "Tavera-Cifuentes", , "[email protected]", role = c("aut", "cre"),
+    person("Maria Camila", "Tavera-Cifuentes", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0009-0007-1610-4583")),
     person("Julian", "Otero", , "[email protected]", role = "aut",
            comment = c(ORCID = "0009-0006-0429-7747")),
-    person("Juan D.", "Umana", , "[email protected]", role = "aut",
-           comment = c(ORCID = "0000-0003-0316-6164")),
-    person("Juan", "Montenegro-Torres", , "[email protected]", role = "aut",
-           comment = c(ORCID = "0000-0003-2755-4743")),
-    person("Juan Manuel", "Cordovez", , "[email protected]", role = "ctb",
-           comment = c(ORCID = "0000-0002-4005-3567")),
+    person("Natalia", "Nino-Machado", , "[email protected]", role = "ctb",
+           comment = c(ORCID = "0000-0001-7887-9439")),
     person("Catalina", "Gonzalez-Uribe", , "[email protected]", role = "ctb",
            comment = c(ORCID = "0000-0002-3322-5017")),
-    person("Mauricio", "Santos-Vega", , "[email protected]", role = "ctb",
-           comment = c(ORCID = "0000-0002-8130-6014")),
+    person("Juan Manuel", "Cordovez", , "[email protected]", role = "ctb",
+           comment = c(ORCID = "0000-0002-4005-3567")),
+    person("Hugo", "Gruson", , "[email protected]", role = "rev",
+           comment = c(ORCID = "0000-0002-4094-1476")),
     person("Chris", "Hartgerink", , "[email protected]", role = "rev",
-           comment = c(ORCID = "0000-0003-1050-6809"))
+           comment = c(ORCID = "0000-0003-1050-6809")),
+    person("Karim", "Mane", , "[email protected]", role = "rev",
+           comment = c(ORCID = "0000-0002-9892-2999")),
+    person("Joshua W.", "Lambert", , "[email protected]", role = "rev",
+           comment = c(ORCID = "0000-0001-5218-3046"))
   )
 Description: ColOpenData is a package that acquires and wrangles Colombian
-    socioeconomic, geospatial, population and climate data. It solves the 
-    problem of Colombian data being issued in different web pages and sources by
-    using functions that allow the user to select the desired database and
-    download it without having to do the exhausting acquisition process.
+    socioeconomic, geospatial, population and climate data. It solves the
+    problem of Colombian data being issued in different web pages and
+    sources by using functions that allow the user to select the desired
+    database and download it without having to do the exhausting
+    acquisition process.
 License: MIT + file LICENSE
 URL: https://github.com/epiverse-trace/ColOpenData,
     https://epiverse-trace.github.io/ColOpenData/
@@ -34,14 +37,12 @@ Imports:
     checkmate,
     config,
     dplyr,
-    httr2,
     magrittr,
-    readr,
     rlang,
     sf,
-    utils,
     stringdist,
-    tidyr
+    tidyr,
+    utils
 Suggests: 
     ggplot2,
     knitr,
@@ -57,4 +58,4 @@ Encoding: UTF-8
 Language: en-US
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+RoxygenNote: 7.3.2
diff --git a/LICENSE b/LICENSE
@@ -1,2 +1,2 @@
-YEAR: 2023
+YEAR: 2024
 COPYRIGHT HOLDER: ColOpenData authors
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2023 ColOpenData authors
+Copyright (c) 2024 ColOpenData authors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/NAMESPACE b/NAMESPACE
@@ -3,14 +3,15 @@
 export(aggregate_climate)
 export(code_to_name_dep)
 export(code_to_name_mun)
-export(dictionary)
 export(divipola_table)
 export(download_climate)
 export(download_climate_geom)
 export(download_climate_stations)
 export(download_demographic)
 export(download_geospatial)
 export(download_pop_projections)
+export(geospatial_dictionary)
+export(get_climate_tags)
 export(list_datasets)
 export(look_up)
 export(merge_geo_demographic)

diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,11 @@
-# 0.1.0
+# 0.2.0
 
-* This project now includes a
-   [`NEWS.md`](https://r-pkgs.org/other-markdown.html#sec-news) file to inform
-   users about changes and new features.
+This project now includes a [`NEWS.md`](https://r-pkgs.org/other-markdown.html#sec-news) file to inform users about changes and new features.
+
+## New Features
+
+-   **Data Categories:** ColOpenData now includes four data categories: demographic, geospatial, climate, and population projections.
+
+-   **Data Merging:** Users can now merge information from demographic and geospatial data.
+
+-   **Auxiliary Functions:** Added auxiliary functions to retrieve information using DIVIPOLA codification.