Download microdata of emigration records from Brazil's census
Source:R/read_emigration.R
read_emigration.Rd
Download microdata of emigration records from Brazil's census. Data collected in the sample component of the questionnaire.
Usage
read_emigration(
year = 2010,
columns = NULL,
add_labels = NULL,
merge_households = FALSE,
as_data_frame = FALSE,
showProgress = TRUE,
cache = TRUE
)
Arguments
- year
Numeric. Year of reference in the format
yyyy
. Defaults to2010
.- columns
String. A vector of column names to keep. The rest of the columns are not read. Defaults to
NULL
and read all columns.- add_labels
Character. Whether the function should add labels to the responses of categorical variables. When
add_labels = "pt"
, the function adds labels in Portuguese. Defaults toNULL
.- merge_households
Logical. Indicate whether the function should merge household variables to the output data. Defaults to
FALSE
.- as_data_frame
Logical. When
FALSE
(Default), the function returns an Arrow Dataset, which allows users to work with larger-than-memory data. IfTRUE
, the function returnsdata.frame
.- showProgress
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.- cache
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. IfFALSE
, the function will download the data again and overwrite the local file.
See also
Other Microdata:
read_families()
,
read_households()
,
read_mortality()
,
read_population()
Examples
# return data as arrow Dataset
df <- read_emigration(year = 2010,
showProgress = FALSE)
#> Downloading data and storing it locally for future use.
# return data as data.frame
df <- read_emigration(year = 2010,
as_data_frame = TRUE,
showProgress = FALSE)
#> Reading data cached locally.
#> Warning: Potentially unsafe or invalid elements have been discarded from R metadata.
#> ℹ Type: "externalptr"
#> → If you trust the source, you can set `options(arrow.unsafe_metadata = TRUE)` to preserve them.