Extends README and translates some spanish words to english

R/data.R

@@ -1,17 +1,17 @@
 #' Available tables
 #'
-#' A list of the available tables in the spanish 2021 Census API
-#' @name tablas
+#' A list of the available tables in the Spanish 2021 Census API
+#' @name tables
 #' @format A data frame with 7 rows and 3 columns:
 #' \describe{
 #'   \item{id_tabla}{Table ID}
 #'   \item{descripcion_tabla_es, descripcion_tabla_en}{Content description of the table in spanish and english}
 #' }
 #' @source <https://www.ine.es/censos2021/SDC21_tablas_disponibles.xlsx>
-"tablas"
+"tables"
 #' Available variables
 #'
-#' A list of the available variables in the spanish 2021 Census API
+#' A list of the available variables in the Spanish 2021 Census API
 #' @name variables
 #' @format A data frame with 395 rows and 4 columns:
 #' \describe{
@@ -23,14 +23,14 @@
 "variables"
 #' Available units of measurement
 #'
-#' A list of the available units of measurement in the spanish 2021 Census API
+#' A list of the available units of measurement in the Spanish 2021 Census API
 #'
-#' @name metricas
+#' @name metrics
 #' @format A data frame with 51 rows and 4 columns:
 #' \describe{
 #'   \item{id_tabla}{Table ID}
 #'   \item{id_unidad_de_medida}{unit ID}
 #'   \item{descripcion_unidad_de_medida_es, descripcion_unidad_de_medida_en}{Content description of the unit of measurement in spanish and english}
 #' }
 #' @source <https://www.ine.es/censos2021/SDC21_variables_disponibles.xlsx>
-"metricas"
+"metrics"

R/get_censo.R

@@ -1,6 +1,6 @@
-#' Get data from the 2021 spanish census
+#' Get data from the 2021 Spanish census
 #'
-#' `get_censo` retrieves data from the 2021 spanish census through the API of the National Institute of Statistics. For more info on the available tables and variables visit https://www.ine.es/dyngs/DataLab/en/manual.html?cid=1259945952385.
+#' `get_censo` retrieves data from the 2021 Spanish census through the API of the National Institute of Statistics. For more info on the available tables and variables visit https://www.ine.es/dyngs/DataLab/en/manual.html?cid=1259945952385.
 #'
 #' @param table  A string of length 1 with the table name to query data from.
 #' @param variables A string with variable names of the queried table. If more than one, must be provided using c() (max. 4)

README.md

@@ -6,11 +6,52 @@
 
 <!-- badges: end -->
 
-`tidycenso` is an R library for accesing the 2021 spanish census.
+## Overview
 
-It's only function `get_censo` admits 4 parameters:
+`tidycenso` is an R library for accessing the 2021 Spanish census API.
+
+## Installation
+
+```         
+devtools::install_github("hmeleiro/tidycenso")
+```
+
+## Usage
+
+`tidycenso` only has one function: `get_censo`. It admits 4 parameters:
 
 1.  table: A string of length 1 with the table name to query data from
 2.  variables: A string with variable names of the queried table. If more than one, must be provided using c() (max. 4)
 3.  metrics: A string with the units of measurement of the queried data. If more than one, must be provided concatenated using 'c()'
 4.  language: The language used in the request body (the only valid values are 'EN' or 'ES')
+
+The ids and descriptions of the available tables, variables and units of measurement (metrics) are accessible through internal data objects named `tables`, `variables`, and `metrics`.
+
+## Example
+
+```         
+df <- get_censo("hog", c("ID_SUP_VIV", "ID_RESIDENCIA_N1"), "SHOGARES")
+head(df)
+
+#>   SHOGARES        ID_RESIDENCIA_N1  ID_SUP_VIV
+#> 1    25464               Andalucía Hasta 30 m2
+#> 2     2586                  Aragón Hasta 30 m2
+#> 3     3252 Asturias, Principado de Hasta 30 m2
+#> 4     7686          Balears, Illes Hasta 30 m2
+#> 5    11766                Canarias Hasta 30 m2
+#> 6     1005               Cantabria Hasta 30 m2
+
+        
+tidycenso::tables
+
+#> # A tibble: 7 x 3
+#>   id_tabla descripcion_tabla_es                        descripcion_tabla_en
+#>   <chr>    <chr>                                       <chr>               
+#> 1 hog      Hogares                                     Households          
+#> 2 nuc      Parejas y otros núcleos familiares          Couples and other f~
+#> 3 per.estu Personas empadronadas en establecimientos ~ Persons registered ~
+#> 4 per.ocu  Personas residentes en viviendas familiares Persons resident in~
+#> 5 per.ppal Total de Personas                           All persons         
+#> 6 viv.fam  Viviendas familiares                        Dwellings           
+#> 7 viv.ppal Ocupados de 16 y más años                   Employed persons ag~
+```

data-raw/save-rda.R

@@ -1,13 +1,13 @@
 library(dplyr)
 
-tablas <- readxl::read_xlsx("data-raw/SDC21_tablas_disponibles.xlsx") %>%
+tables <- readxl::read_xlsx("data-raw/SDC21_tablas_disponibles.xlsx") %>%
   janitor::clean_names()
-usethis::use_data(tablas, overwrite = T)
+usethis::use_data(tables, overwrite = T)
 
 variables <- readxl::read_xlsx("data-raw/SDC21_variables_disponibles.xlsx") %>%
   janitor::clean_names()
 usethis::use_data(variables, overwrite = T)
 
-metricas <- readxl::read_xlsx("data-raw/SDC21_unidades_medida_disponibles.xlsx") %>%
+metrics <- readxl::read_xlsx("data-raw/SDC21_unidades_medida_disponibles.xlsx") %>%
   janitor::clean_names()
-usethis::use_data(metricas, overwrite = T)
+usethis::use_data(metrics, overwrite = T)