R/read_households.R
read_households.Rd
Download microdata of household records from Brazil's census. Data collected in the sample component of the questionnaire.
read_households(
year = 2010,
columns = NULL,
add_labels = NULL,
as_data_frame = FALSE,
showProgress = TRUE,
cache = TRUE
)
Numeric. Year of reference in the format yyyy
. Defaults to 2010
.
String. A vector of column names to keep. The rest of the
columns are not read. Defaults to NULL
and read all columns.
Character. Whether the function should add labels to the
responses of categorical variables. When add_labels = "pt"
, the
function adds labels in Portuguese. Defaults to NULL
.
Logical. When FALSE
(Default), the function returns an
Arrow Dataset, which allows users to work with larger-than-memory data.
If TRUE
, the function returns data.frame
.
Logical. Defaults to TRUE
display download progress
bar. The progress bar only reflects only the downloading
time, not the time to load the data to memory.
Logical. Whether the function should read the data cached
locally, which is much faster. Defaults to TRUE
. The first time the
user runs the function, censobr
will download the file and store it
locally so that the file only needs to be download once. If FALSE
,
the function will download the data again and overwrite the local file.
An arrow Dataset
or a "data.frame"
object.
Other Microdata:
read_emigration()
,
read_families()
,
read_mortality()
,
read_population()
# return data as arrow Dataset
df <- read_households(year = 2010,
showProgress = FALSE)
#> Downloading data and storing it locally for future use.