Update Description and README

epiverse-trace · Jul 31, 2024 · 3740c91 · 3740c91
1 parent 876f7bd
commit 3740c91
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 20 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,5 +1,5 @@
 Package: ColOpenData
-Title: Colombian Open Data Download and Wrangling
+Title: Download Colombian Demographic, Climate and Geospatial Data
 Version: 0.2.0
 Authors@R: c(
     person("Maria Camila", "Tavera-Cifuentes", , "[email protected]", role = c("aut", "cre"),
@@ -21,12 +21,11 @@ Authors@R: c(
     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.
+Description: This package 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.
 License: MIT + file LICENSE
 URL: https://github.com/epiverse-trace/ColOpenData,
     https://epiverse-trace.github.io/ColOpenData/

diff --git a/R/retrieve.R b/R/retrieve.R
@@ -83,7 +83,7 @@ retrieve_climate_path <- function() {
 #' Dictionaries are not included in the general documentation file. Therefore,
 #' the path is built internally.
 #'
-#' @param dataset character with the dictionary name.
+#' @param dict_name character with the dictionary name.
 #'
 #' @return character with path to retrieve the dataset.
 #'

diff --git a/README.Rmd b/README.Rmd
@@ -25,7 +25,7 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/) [![R-CMD-check](https://github.com/epiverse-trace/ColOpenData/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiverse-trace/ColOpenData/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/epiverse-trace/ColOpenData/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiverse-trace/ColOpenData?branch=main) [![lifecycle-experimental](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-experimental.svg)](https://www.reconverse.org/lifecycle.html#experimental) [![CRAN status](https://www.r-pkg.org/badges/version/ColOpenData)](https://CRAN.R-project.org/package=ColOpenData)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit) [![R-CMD-check](https://github.com/epiverse-trace/ColOpenData/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiverse-trace/ColOpenData/actions/workflows/R-CMD-check.yaml) [![Codecov test coverage](https://codecov.io/gh/epiverse-trace/ColOpenData/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiverse-trace/ColOpenData?branch=main) [![lifecycle-experimental](https://raw.githubusercontent.com/reconverse/reconverse.github.io/master/images/badge-experimental.svg)](https://www.reconverse.org/lifecycle.html#experimental) [![CRAN status](https://www.r-pkg.org/badges/version/ColOpenData)](https://CRAN.R-project.org/package=ColOpenData)
 
 <!-- badges: end -->
 
@@ -44,13 +44,13 @@ pak::pak("epiverse-trace/ColOpenData")
 
 ## Quick Overview
 
-**ColOpenData** contains data from two public data sources: The National Administrative Department of Statistics [(DANE)](https://www.dane.gov.co/index.php/en/), and the Institute of Hydrology, Meteorology and Environmental Studies [(IDEAM)](http://www.ideam.gov.co/). The available data is divided in four categories:
+**ColOpenData** contains data from two public data sources: The National Administrative Department of Statistics [(DANE)](https://www.dane.gov.co/index.php/en/), and the Institute of Hydrology, Meteorology and Environmental Studies [(IDEAM)](https://www.ideam.gov.co/). The available data is divided in four categories:
 
 -   **Demographic:** Demographic and Socioeconomic data presents information from the National Population and Dwelling Census (CNPV) of 2018. The CNPV data corresponds to the most recent census available to date and the information is presented as an answer to three questions: How many are we?, Where are we? and How do we live? Further information can be consulted at the [CNPV results](https://www.dane.gov.co/index.php/estadisticas-por-tema/demografia-y-poblacion/censo-nacional-de-poblacion-y-vivenda-2018).
 
 -   **Geospatial:** This data is retrieved from the National Geostatistical Framework (MGN), which includes maps and a summarized version of the 2018 CNPV, aggregated to spatial geometries. The data is available at different aggregation levels including: Blocks, Urban and Rural Sections, Urban and Rural Sectors, Urban Areas, Municipalities and Departments. More information is available at [MGN update news](https://www.dane.gov.co/index.php/actualidad-dane/5454-el-dane-actualizo-el-marco-geoestadistico-nacional-a-2018).
 
--   **Climate:** Climate data is recovered from backup information provided by IDEAM, containing historical data from the first station in the country (January 1st 1920) until May 31st 2023. This backup includes temperature, precipitation, sunshine duration, wind direction, among others. More information can be found at [IDEAM website](http://www.ideam.gov.co/).
+-   **Climate:** Climate data is recovered from backup information provided by IDEAM, containing historical data from the first station in the country (January 1st 1920) until May 31st 2023. This backup includes temperature, precipitation, sunshine duration, wind direction, among others. More information can be found at [IDEAM website](https://www.ideam.gov.co/).
 
 -   **Population projections:** Population Projections data contains the population projections and back projections from 1950 to 2070, considering the post COVID-19 update, which was calculated based on the results of 2018 CNPV. Further information can be consulted at [DANE website](https://www.dane.gov.co/index.php/estadisticas-por-tema/demografia-y-poblacion/proyecciones-de-poblacion).
 
@@ -76,7 +76,7 @@ This package is currently *experimental*, as defined by the [RECON software life
 
 ### Contributions
 
-Contributions are welcome via [pull requests](https://github.com/ColOpenData/pulls).
+Contributions are welcome via [pull requests](https://github.com/epiverse-trace/ColOpenData/pulls).
 
 ### Code of Conduct
 

diff --git a/README.md b/README.md
@@ -5,12 +5,12 @@
 <!-- `packagename` is extracted from the DESCRIPTION file -->
 <!-- `gh_repo` is extracted via a special environment variable in GitHub Actions -->
 
-# ColOpenData <img src="man/figures/logo.svg" align="right" width="200"/>
+# {{ packagename }} <img src="man/figures/logo.svg" align="right" width="200"/>
 
 <!-- badges: start -->
 
 [![License:
-MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
+MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)
 [![R-CMD-check](https://github.com/epiverse-trace/ColOpenData/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiverse-trace/ColOpenData/actions/workflows/R-CMD-check.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/epiverse-trace/ColOpenData/branch/main/graph/badge.svg)](https://app.codecov.io/gh/epiverse-trace/ColOpenData?branch=main)
@@ -49,7 +49,7 @@ pak::pak("epiverse-trace/ColOpenData")
 Administrative Department of Statistics
 [(DANE)](https://www.dane.gov.co/index.php/en/), and the Institute of
 Hydrology, Meteorology and Environmental Studies
-[(IDEAM)](http://www.ideam.gov.co/). The available data is divided in
+[(IDEAM)](https://www.ideam.gov.co/). The available data is divided in
 four categories:
 
 - **Demographic:** Demographic and Socioeconomic data presents
@@ -74,7 +74,7 @@ four categories:
   in the country (January 1st 1920) until May 31st 2023. This backup
   includes temperature, precipitation, sunshine duration, wind
   direction, among others. More information can be found at [IDEAM
-  website](http://www.ideam.gov.co/).
+  website](https://www.ideam.gov.co/).
 
 - **Population projections:** Population Projections data contains the
   population projections and back projections from 1950 to 2070,
@@ -111,7 +111,7 @@ development team. However, it still may change over time.
 ### Contributions
 
 Contributions are welcome via [pull
-requests](https://github.com/ColOpenData/pulls).
+requests](https://github.com/epiverse-trace/ColOpenData/pulls).
 
 ### Code of Conduct
 

diff --git a/man/retrieve_dict_path.Rd b/man/retrieve_dict_path.Rd
diff --git a/vignettes/climate_data.Rmd b/vignettes/climate_data.Rmd
@@ -17,7 +17,7 @@ knitr::opts_chunk$set(
 ```
 
 ::: {style="text-align: justify;"}
-**ColOpenData** can be used to access open climate data from Colombia. This climate data is retrieved from the Institute of Hydrology, Meteorology and Environmental Studies [(IDEAM)](http://www.ideam.gov.co/). The climate module allows the user to consult climate data for any Region of Interest (ROI) inside the country and retrieve the information for each station contained inside.
+**ColOpenData** can be used to access open climate data from Colombia. This climate data is retrieved from the Institute of Hydrology, Meteorology and Environmental Studies [(IDEAM)](https://www.ideam.gov.co/). The climate module allows the user to consult climate data for any Region of Interest (ROI) inside the country and retrieve the information for each station contained inside.
 
 The available information from IDEAM can be accessed using specific internal tags as follows:
 :::
@@ -111,7 +111,7 @@ head(stations)
 ```
 
 ::: {style="text-align: justify;"}
-We can see that in the region there are 129 stations. Different categories are recorded by different stations, and can be checked at the column [categoria]{.underline}. To understand the category of each station we can use the [definition catalog](http://www.ideam.gov.co/documents/10182/557765/Definiciones+CNE.pdf/25e1cca5-ee47-4eaf-86c0-c4f5192a9937) provided by IDEAM. Stations under the categories *Climática Principal* and *Climática Ordinaria* have records of temperature.
+We can see that in the region there are 129 stations. Different categories are recorded by different stations, and can be checked at the column [categoria]{.underline}. Stations under the categories *Climática Principal* and *Climática Ordinaria* have records of temperature.
 
 Some stations are suspended, which means they are not taking measurements at the moment. This information is found at the column [estado]{.underline} where, if suspended, the observation would be *Suspendida* Also, at the column [fecha_suspension]{.underline} the observation would be different from `NA`, since suspended stations would have an associated suspension date. However, even if a station is suspended, the historical data (up to the suspension date) can be accessed.