From cd36ec1953416d7c1c03b8296c710180aa516428 Mon Sep 17 00:00:00 2001 From: SoyAndrea Date: Tue, 26 Nov 2024 21:17:55 -0300 Subject: [PATCH] update roadmap --- R/check_repository.R | 2 +- R/get_census.R | 2 +- README.Rmd | 9 +++++++-- README.md | 10 ++++++++-- man/check_repository.Rd | 2 +- man/get_census.Rd | 2 +- 6 files changed, 19 insertions(+), 8 deletions(-) diff --git a/R/check_repository.R b/R/check_repository.R index 74c2d68..5e6255b 100644 --- a/R/check_repository.R +++ b/R/check_repository.R @@ -1,7 +1,7 @@ #' check_repository #'reports the tables currently available in the package #' @param year census year for which the user wants to view the currently available tabulations. The default is “1970”. -#' @param topic census topic of the tables Setting the parameter to NULL will download all available tables. +#' @param topic census topic of the tables available: ESTRUCTURA DE POBLACION, CONDICION DE ACTIVIDAD, FECUNDIDAD, CONDICIONES HABITACIONALES, COMPOSICIÓN DE LO HOGARES, MIGRACIÓN, SITUACIÓN CONYUGAL y EDUCACION. Setting the parameter to NULL will download all available tables. #' @param geolvl geographic disaggregation level, use “Total del país” for the overall results. Setting the parameter to NULL will download all available tables. #' #' @return Returns a data frame with the title of the tables that can be acces with the get_census function and the name given by that function to each table diff --git a/R/get_census.R b/R/get_census.R index 7fc2f63..4043fd2 100644 --- a/R/get_census.R +++ b/R/get_census.R @@ -1,7 +1,7 @@ #' get_census #'get a list with the tables currently available in the package #' @param year census year for which the user wants to view the currently available tabulations. The default is “1970”. -#' @param topic census topic of the tables Setting the parameter to NULL will download all available tables. +#' @param topic census topic of the tables available: ESTRUCTURA DE POBLACION, CONDICION DE ACTIVIDAD, FECUNDIDAD, CONDICIONES HABITACIONALES, COMPOSICIÓN DE LO HOGARES, MIGRACIÓN, SITUACIÓN CONYUGAL y EDUCACION. Setting the parameter to NULL will download all available tables. #' @param geolvl geographic disaggregation level, use “Total del país” for the overall results. Setting the parameter to NULL will download all available tables. #' #' @return Returns a list with the tables that meet the parameters. To check the tables currently available use the check_repository function diff --git a/README.Rmd b/README.Rmd index 5e7e3cb..46a7c7b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -34,6 +34,9 @@ This project was supported by the [rOpenSci Champions Program](https://ropensci. This package aims to make census data available, homogenized and ready to use. It will include the census data from 1970 to 2022. Having a package of census information will allow the public and private sectors, citizens and other actors in society to access current and historical information on Argentina’s population, households and housing in a more accessible way. +> **The available data will be added to the package in stages as shown in the graphic below by year and geographic disaggregation. Currently, the package is in stage 1 of the roadmap.** + +![](docs/roadmap.png) ## Installation @@ -41,6 +44,8 @@ You can install the development version of arcenso from [GitHub](https://github. ``` r # install.packages("remotes") +# if you do not have remotes installed + remotes::install_github("SoyAndrea/arcenso") ``` @@ -63,10 +68,10 @@ library(arcenso) ## get a list with the tables currently available in the package -get_census( year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") +get_census(year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") ## reports the tables currently available in the package -check_repository( year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") +check_repository(year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") ``` diff --git a/README.md b/README.md index 50262c8..ead201f 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,12 @@ citizens and other actors in society to access current and historical information on Argentina’s population, households and housing in a more accessible way. +> **The available data will be added to the package in stages as shown +> in the graphic below by year and geographic disaggregation. Currently, +> the package is in stage 1 of the roadmap.** + +![](docs/roadmap.png) + ## Installation You can install the development version of arcenso from @@ -61,7 +67,7 @@ library(arcenso) ## get a list with the tables currently available in the package -get_census( year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") +get_census(year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") #> $c70_total_del_pais_poblacion_c18 #> regimen_de_tenencia hogares personas cuartos #> 1 Propietario 3553250 13778700 11197900 @@ -136,7 +142,7 @@ get_census( year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total d ## reports the tables currently available in the package -check_repository( year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") +check_repository(year = 1970, topic = "CONDICIONES HABITACIONALES", geolvl = "Total del país") #> Archivo #> 1 c70_total_del_pais_poblacion_c18 #> 2 c70_total_del_pais_poblacion_c20 diff --git a/man/check_repository.Rd b/man/check_repository.Rd index fe8857f..6c1e178 100644 --- a/man/check_repository.Rd +++ b/man/check_repository.Rd @@ -10,7 +10,7 @@ check_repository(year = 1970, topic = NULL, geolvl = NULL) \arguments{ \item{year}{census year for which the user wants to view the currently available tabulations. The default is “1970”.} -\item{topic}{census topic of the tables Setting the parameter to NULL will download all available tables.} +\item{topic}{census topic of the tables available: ESTRUCTURA DE POBLACION, CONDICION DE ACTIVIDAD, FECUNDIDAD, CONDICIONES HABITACIONALES, COMPOSICIÓN DE LO HOGARES, MIGRACIÓN, SITUACIÓN CONYUGAL y EDUCACION. Setting the parameter to NULL will download all available tables.} \item{geolvl}{geographic disaggregation level, use “Total del país” for the overall results. Setting the parameter to NULL will download all available tables.} } diff --git a/man/get_census.Rd b/man/get_census.Rd index e63a0e2..5f2cd6b 100644 --- a/man/get_census.Rd +++ b/man/get_census.Rd @@ -10,7 +10,7 @@ get_census(year = 1970, topic = NULL, geolvl = NULL) \arguments{ \item{year}{census year for which the user wants to view the currently available tabulations. The default is “1970”.} -\item{topic}{census topic of the tables Setting the parameter to NULL will download all available tables.} +\item{topic}{census topic of the tables available: ESTRUCTURA DE POBLACION, CONDICION DE ACTIVIDAD, FECUNDIDAD, CONDICIONES HABITACIONALES, COMPOSICIÓN DE LO HOGARES, MIGRACIÓN, SITUACIÓN CONYUGAL y EDUCACION. Setting the parameter to NULL will download all available tables.} \item{geolvl}{geographic disaggregation level, use “Total del país” for the overall results. Setting the parameter to NULL will download all available tables.} }