Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions R/download_climate.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Comment on lines +204 to +205
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove these lines

"Stored by Universidad de Los Andes under the Epiverse TRACE iniative."
)
))
Expand Down
14 changes: 10 additions & 4 deletions R/download_demographic.R
Original file line number Diff line number Diff line change
Expand Up @@ -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."
)
))
Expand Down
14 changes: 10 additions & 4 deletions R/download_geospatial.R
Original file line number Diff line number Diff line change
Expand Up @@ -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."
)
))
Expand Down
13 changes: 9 additions & 4 deletions R/download_population_projections.R
Original file line number Diff line number Diff line change
Expand Up @@ -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."
)
))
Expand Down
22 changes: 18 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand All @@ -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?

Expand All @@ -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.

Expand All @@ -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.
Expand Down
33 changes: 27 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down
6 changes: 6 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
Estadística
Instituto
Hidrología
Meteorología
Estudios
Ambientales
Geospatial
CMD
Codecov
Expand Down
42 changes: 30 additions & 12 deletions tests/testthat/_snaps/download_climate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 10 additions & 4 deletions tests/testthat/_snaps/download_demographic.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
28 changes: 20 additions & 8 deletions tests/testthat/_snaps/download_geospatial.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 10 additions & 4 deletions tests/testthat/_snaps/download_population_projections.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading