diff --git a/R/download_climate.R b/R/download_climate.R index 080180f..34bc3cc 100644 --- a/R/download_climate.R +++ b/R/download_climate.R @@ -193,10 +193,16 @@ download_climate_stations <- function(stations, start_date, end_date, tag) { message(strwrap( prefix = "\n", initial = "", c( - "Original data is retrieved from the Institute of Hydrology, Meteorology - and Environmental Studies (Instituto de Hidrolog\u00eda, - Meteorolog\u00eda y Estudios Ambientales - IDEAM).", - "Reformatted by package authors.", + "ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estad\u00edstica (DANE), and Instituto de Hidrolog\u00eda, + Meteorolog\u00eda y Estudios Ambientales (IDEAM) but with modifications + for specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. The + authors of ColOpenData are not liable for how users utilize the data, + and users areresponsible for any outcomes from their use or analysis of + the data.", "Stored by Universidad de Los Andes under the Epiverse TRACE iniative." ) )) diff --git a/R/download_demographic.R b/R/download_demographic.R index a030a26..38e5205 100644 --- a/R/download_demographic.R +++ b/R/download_demographic.R @@ -27,10 +27,16 @@ download_demographic <- function(dataset) { message(strwrap( prefix = "\n", initial = "", c( - "Original data is retrieved from the National Administrative Department of - Statistics (Departamento Administrativo Nacional de - Estad\u00edstica - DANE).", - "Reformatted by package authors.", + "ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estad\u00edstica (DANE), and Instituto de Hidrolog\u00eda, + Meteorolog\u00eda y Estudios Ambientales (IDEAM) but with modifications + for specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. The + authors of ColOpenData are not liable for how users utilize the data, + and users areresponsible for any outcomes from their use or analysis of + the data.", "Stored by Universidad de Los Andes under the Epiverse TRACE iniative." ) )) diff --git a/R/download_geospatial.R b/R/download_geospatial.R index 307988a..71d3509 100644 --- a/R/download_geospatial.R +++ b/R/download_geospatial.R @@ -70,10 +70,16 @@ download_geospatial <- function(spatial_level, simplified = TRUE, message(strwrap( prefix = "\n", initial = "", c( - "Original data is retrieved from the National Administrative Department of - Statistics (Departamento Administrativo Nacional de - Estad\u00edstica - DANE).", - "Reformatted by package authors.", + "ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estad\u00edstica (DANE), and Instituto de Hidrolog\u00eda, + Meteorolog\u00eda y Estudios Ambientales (IDEAM) but with modifications + for specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. The + authors of ColOpenData are not liable for how users utilize the data, + and users areresponsible for any outcomes from their use or analysis of + the data.", "Stored by Universidad de Los Andes under the Epiverse TRACE iniative." ) )) diff --git a/R/download_population_projections.R b/R/download_population_projections.R index 6b5e560..6e7965f 100644 --- a/R/download_population_projections.R +++ b/R/download_population_projections.R @@ -97,10 +97,15 @@ download_pop_projections <- function(spatial_level, start_year, end_year, message(strwrap( prefix = "\n", initial = "", c( - "Original data is retrieved from the National Administrative Department of - Statistics (Departamento Administrativo Nacional de - Estad\u00edstica - DANE).", - "Reformatted by package authors.", + "ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, Meteorología + y Estudios Ambientales (IDEAM)but with modifications for specific + functional needs. These changes may alter the structure, format, or + content, meaning the data does not reflect the official dataset. The + package is developed independently, with no endorsement or involvement + from these institutions or any Colombian government body. The authors of + ColOpenData are not liable for how users utilize the data, and users are + responsible for any outcomes from their use or analysis of the data.", "Stored by Universidad de Los Andes under the Epiverse TRACE iniative." ) )) diff --git a/README.Rmd b/README.Rmd index 3b1484b..0dc923c 100644 --- a/README.Rmd +++ b/README.Rmd @@ -41,11 +41,11 @@ ColOpenData is developed at [Universidad de Los Andes](https://www.uniandes.edu. You can install the CRAN version of ColOpenData with: -```{r} +```{r eval=FALSE, include=TRUE} install.packages("ColOpenData") ``` -You can also install the development version of ColOpenData from [GitHub](https://github.com/) with: +You can also install the development version of ColOpenData from [GitHub](https://github.com/) with: ``` r # install.packages("pak") @@ -54,7 +54,7 @@ pak::pak("epiverse-trace/ColOpenData") ## Quick Overview -**ColOpenData** contains data from two public data sources: The National Administrative Department of Statistics (DANE), and the Institute of Hydrology, Meteorology and Environmental Studies (IDEAM). The available data is divided in four categories: +**ColOpenData** contains data from two public data sources: Departamento Administrativo Nacional de Estadística (DANE), and Instituto de Hidrología, Meteorología y Estudios Ambientales (IDEAM). 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? @@ -66,7 +66,7 @@ pak::pak("epiverse-trace/ColOpenData") Documentation and vignettes are available for the modules in the [user vignettes](https://epiverse-trace.github.io/ColOpenData/). -### Related R Packages +### Similar R Packages Similar R packages are offered for international communities, allowing the user to download census, geospatial and climate data. @@ -80,6 +80,20 @@ Similar R packages are offered for international communities, allowing the user - [geofi](https://ropengov.github.io/geofi/): Finland - [climate](https://bczernecki.github.io/climate/) +### Disclaimer + +ColOpenData stores and distributes open data originally obtained from Departamento Administrativo Nacional de Estadística (DANE), and Instituto de Hidrología, Meteorología y Estudios Ambientales (IDEAM). It is important to note that the data retrieved from these sources has been processed, transformed, and adapted to meet the functional requirements of this package. These modifications may result in changes to the structure, format, or content of the original data, and as such, the data provided by this package does not represent the official datasets as maintained by IDEAM or DANE. +The development of this package is completely independent of these institutions, +and neither IDEAM, DANE, nor any other Colombian government body endorses, +sponsors, or is involved in the creation or maintenance of this package. +Consequently, they bear no responsibility for the data as presented within this +package. Furthermore, the authors of the ColOpenData assume no liability for any +outcomes resulting from the use or misuse of the data provided. The user is +solely responsible for how they utilize the data, and any conclusions drawn, +analyses performed, or actions taken based on this data are the user's +responsibility. This package and its authors make no claims to represent or act +on behalf of IDEAM, DANE, or any other official entity. + ### Lifecycle This package is currently *stable*, as defined by the [RECON software lifecycle](https://www.reconverse.org/lifecycle.html). Therefore, this is a functional package and it is documented and tested. However, it still may change over time. diff --git a/README.md b/README.md index 10b107c..b52e6c2 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,6 @@ You can install the CRAN version of ColOpenData with: ``` r install.packages("ColOpenData") -#> Installing package into '/home/runner/work/_temp/Library' -#> (as 'lib' is unspecified) ``` You can also install the development version of ColOpenData from @@ -56,9 +54,9 @@ pak::pak("epiverse-trace/ColOpenData") ## Quick Overview -**ColOpenData** contains data from two public data sources: The National -Administrative Department of Statistics (DANE), and the Institute of -Hydrology, Meteorology and Environmental Studies (IDEAM). The available +**ColOpenData** contains data from two public data sources: Departamento +Administrativo Nacional de Estadística (DANE), and Instituto de +Hidrología, Meteorología y Estudios Ambientales (IDEAM). The available data is divided in four categories: - **Demographic:** Demographic and Socioeconomic data presents @@ -88,7 +86,7 @@ data is divided in four categories: Documentation and vignettes are available for the modules in the [user vignettes](https://epiverse-trace.github.io/ColOpenData/). -### Related R Packages +### Similar R Packages Similar R packages are offered for international communities, allowing the user to download census, geospatial and climate data. @@ -103,6 +101,29 @@ the user to download census, geospatial and climate data. - [geofi](https://ropengov.github.io/geofi/): Finland - [climate](https://bczernecki.github.io/climate/) +### Disclaimer + +ColOpenData stores and distributes open data originally obtained from +Departamento Administrativo Nacional de Estadística (DANE), and +Instituto de Hidrología, Meteorología y Estudios Ambientales (IDEAM). It +is important to note that the data retrieved from these sources has been +processed, transformed, and adapted to meet the functional requirements +of this package. These modifications may result in changes to the +structure, format, or content of the original data, and as such, the +data provided by this package does not represent the official datasets +as maintained by IDEAM or DANE. The development of this package is +completely independent of these institutions, and neither IDEAM, DANE, +nor any other Colombian government body endorses, sponsors, or is +involved in the creation or maintenance of this package. Consequently, +they bear no responsibility for the data as presented within this +package. Furthermore, the authors of the ColOpenData assume no liability +for any outcomes resulting from the use or misuse of the data provided. +The user is solely responsible for how they utilize the data, and any +conclusions drawn, analyses performed, or actions taken based on this +data are the user’s responsibility. This package and its authors make no +claims to represent or act on behalf of IDEAM, DANE, or any other +official entity. + ### Lifecycle This package is currently *stable*, as defined by the [RECON software diff --git a/inst/WORDLIST b/inst/WORDLIST index 76c80f4..4bf1f01 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -1,3 +1,9 @@ +Estadística +Instituto +Hidrología +Meteorología +Estudios +Ambientales Geospatial CMD Codecov diff --git a/tests/testthat/_snaps/download_climate.md b/tests/testthat/_snaps/download_climate.md index a9eb2a8..edac686 100644 --- a/tests/testthat/_snaps/download_climate.md +++ b/tests/testthat/_snaps/download_climate.md @@ -29,10 +29,16 @@ download_climate_stations(stations = stations_test, start_date = "2010-10-01", end_date = "2010-12-10", tag = "PTPM_CON") Message - Original data is retrieved from the Institute of Hydrology, Meteorology - and Environmental Studies (Instituto de Hidrología, Meteorología y - Estudios Ambientales - IDEAM). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM) but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users areresponsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output station longitude latitude date hour tag value @@ -113,10 +119,16 @@ download_climate_geom(geometry = apicala, start_date = "2010-10-01", end_date = "2010-11-10", tag = "PTPM_CON") Message - Original data is retrieved from the Institute of Hydrology, Meteorology - and Environmental Studies (Instituto de Hidrología, Meteorología y - Estudios Ambientales - IDEAM). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM) but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users areresponsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output station longitude latitude date hour tag value @@ -167,10 +179,16 @@ download_climate(code = "73148", start_date = "2018-10-01", end_date = "2018-11-10", tag = "PTPM_CON") Message - Original data is retrieved from the Institute of Hydrology, Meteorology - and Environmental Studies (Instituto de Hidrología, Meteorología y - Estudios Ambientales - IDEAM). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM) but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users areresponsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output station longitude latitude date hour tag value diff --git a/tests/testthat/_snaps/download_demographic.md b/tests/testthat/_snaps/download_demographic.md index c10bd82..8243914 100644 --- a/tests/testthat/_snaps/download_demographic.md +++ b/tests/testthat/_snaps/download_demographic.md @@ -3,10 +3,16 @@ Code download_demographic("DANE_CNPVH_2018_1HD") Message - Original data is retrieved from the National Administrative Department - of Statistics (Departamento Administrativo Nacional de Estadística - - DANE). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM) but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users areresponsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output codigo_departamento diff --git a/tests/testthat/_snaps/download_geospatial.md b/tests/testthat/_snaps/download_geospatial.md index 4f9c0e8..5dc7cf6 100644 --- a/tests/testthat/_snaps/download_geospatial.md +++ b/tests/testthat/_snaps/download_geospatial.md @@ -4,10 +4,16 @@ download_geospatial(spatial_level = "department", simplified = TRUE, include_geom = TRUE, include_cnpv = FALSE) Message - Original data is retrieved from the National Administrative Department - of Statistics (Departamento Administrativo Nacional de Estadística - - DANE). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM) but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users areresponsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output Simple feature collection with 33 features and 6 fields @@ -45,10 +51,16 @@ download_geospatial(spatial_level = "dpto", simplified = TRUE, include_geom = FALSE, include_cnpv = TRUE) Message - Original data is retrieved from the National Administrative Department - of Statistics (Departamento Administrativo Nacional de Estadística - - DANE). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM) but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users areresponsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output codigo_departamento departamento diff --git a/tests/testthat/_snaps/download_population_projections.md b/tests/testthat/_snaps/download_population_projections.md index b98c6f0..c172b58 100644 --- a/tests/testthat/_snaps/download_population_projections.md +++ b/tests/testthat/_snaps/download_population_projections.md @@ -8,10 +8,16 @@ Use of .data in tidyselect expressions was deprecated in tidyselect 1.2.0. i Please use `all_of(var)` (or `any_of(var)`) instead of `.data[[var]]` Message - Original data is retrieved from the National Administrative Department - of Statistics (Departamento Administrativo Nacional de Estadística - - DANE). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM)but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users are responsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output codigo_departamento departamento ano diff --git a/tests/testthat/_snaps/merge_geo_demographic.md b/tests/testthat/_snaps/merge_geo_demographic.md index cb01bb6..d8bdc6d 100644 --- a/tests/testthat/_snaps/merge_geo_demographic.md +++ b/tests/testthat/_snaps/merge_geo_demographic.md @@ -3,10 +3,16 @@ Code merge_geo_demographic("DANE_CNPVH_2018_1HD") Message - Original data is retrieved from the National Administrative Department - of Statistics (Departamento Administrativo Nacional de Estadística - - DANE). - Reformatted by package authors. + ColOpenData provides open data derived from Departamento Administrativo + Nacional de Estadística (DANE), and Instituto de Hidrología, + Meteorología y Estudios Ambientales (IDEAM) but with modifications for + specific functional needs. These changes may alter the structure, + format, or content, meaning the data does not reflect the official + dataset. The package is developed independently, with no endorsement or + involvement from these institutions or any Colombian government body. + The authors of ColOpenData are not liable for how users utilize the + data, and users areresponsible for any outcomes from their use or + analysis of the data. Stored by Universidad de Los Andes under the Epiverse TRACE iniative. Output Simple feature collection with 33 features and 9 fields diff --git a/vignettes/climate_data.Rmd b/vignettes/climate_data.Rmd index 2c86680..f4b2d73 100644 --- a/vignettes/climate_data.Rmd +++ b/vignettes/climate_data.Rmd @@ -18,7 +18,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). 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 Instituto de Hidrología, Meteorología y Estudios Ambientales (IDEAM). 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: ::: diff --git a/vignettes/demographic_data.Rmd b/vignettes/demographic_data.Rmd index fead305..8291747 100644 --- a/vignettes/demographic_data.Rmd +++ b/vignettes/demographic_data.Rmd @@ -18,7 +18,7 @@ knitr::opts_chunk$set( ``` ::: {style="text-align: justify;"} -**ColOpenData** can be used to access open demographic data from Colombia. This demographic data is retrieved from the National Administrative Department of Statistics (DANE). The demographic module allows you to consult demographic data from the National Population and Dwelling Census (CNPV) of 2018 and Population Projections. +**ColOpenData** can be used to access open demographic data from Colombia. This demographic data is retrieved from Departamento Administrativo Nacional de Estadística (DANE). The demographic module allows you to consult demographic data from the National Population and Dwelling Census (CNPV) of 2018 and Population Projections. The available CNPV information is divided in four categories: households, persons demographic, persons social and dwellings. The population projections information presents data from 1950 to 2070 for a national level, from 1985 to 2050 for a departmental level and from 1985 to 2035 for a municipal level. All data documentation can be accessed as explained at [Documentation and Dictionaries](https://epiverse-trace.github.io/ColOpenData/articles/documentation_and_dictionaries.html). diff --git a/vignettes/documentation_and_dictionaries.Rmd b/vignettes/documentation_and_dictionaries.Rmd index 9d413f3..545a44c 100644 --- a/vignettes/documentation_and_dictionaries.Rmd +++ b/vignettes/documentation_and_dictionaries.Rmd @@ -37,7 +37,7 @@ Demographic datasets are available for municipalities and departments, and conta - Personas Social (Persons Social). - Personas Demográfico (Persons Demographic). -All datasets are retrieved from the National Administrative Department of Statistics (DANE). Naming is stated as follows: +All datasets are retrieved from Departamento Administrativo Nacional de Estadística (DANE). Naming is stated as follows: - Source: **DANE**. - Group: Names include the categories. @@ -63,7 +63,7 @@ Geospatial datasets naming is related to the level of aggregation, since they ar ## Understanding Climate Dataset ::: {style="text-align: justify;"} -This module's data is stored in an unique dataset, and the information required to use the related functions is the area of interest, dates, and tags be consulted. Individual tags are required to download data and include: +This module's data is retrieved from Instituto de Hidrología, Meteorología y Estudios Ambientales (IDEAM) and is stored in an unique dataset, and the information required to use the related functions is the area of interest, dates, and tags to be consulted. Individual tags are required to download data and include: ::: ```{r IDEAM table, echo = FALSE} @@ -98,7 +98,7 @@ These tags are meant to be used for download using `download_climate()`, `downlo ## Understanding Population Projections ::: {style="text-align: justify;"} -Population projections and back-projections are available for national, department and municipality levels, and divided by sex and ethnicity (the latter is only available for municipalities). The names of the datasets relate to the source, years included, sex and ethnicity. +Population projections and back-projections retrieved from DANE are available for national, department and municipality levels, and divided by sex and ethnicity (the latter is only available for municipalities). The names of the datasets relate to the source, years included, sex and ethnicity. For examples on how to consult the data please refer to [Population Projection with ColOpenData](https://epiverse-trace.github.io/ColOpenData/articles/population_projections.html) ::: diff --git a/vignettes/geospatial_data.Rmd b/vignettes/geospatial_data.Rmd index f871156..93c738f 100644 --- a/vignettes/geospatial_data.Rmd +++ b/vignettes/geospatial_data.Rmd @@ -18,7 +18,7 @@ knitr::opts_chunk$set( ``` ::: {style="text-align: justify;"} -**ColOpenData** can be used to access open geospatial data from Colombia. This data is retrieved from the National Geostatistical Framework (MGN), published by the National Administrative Department of Statistics (DANE). The MGN contains the political-administrative division and is used to reference census statistical information. +**ColOpenData** can be used to access open geospatial data from Colombia. This data is retrieved from the National Geostatistical Framework (MGN), published by Departamento Administrativo Nacional de Estadística (DANE). The MGN contains the political-administrative division and is used to reference census statistical information. This package contains the 2018's version of the MGN, which also included a summarized version of the National Population and Dwelling Census (CNPV) in different aggregation levels. Each level is stored in a different dataset, which can be retrieved using the `download_geospatial()` function, which requires three arguments: