Return the data dictionary of a specific Origin
Destination Survey, if available. This dictionary is intended to be used to
understand the data downloaded using the odbr::read_od
function. It will
contain the list of variables and, for each variable, a simple description,
the available categories and its class (factor, numeric, etc).
read_dictionary(
city = "São Paulo",
year = 2017,
harmonize = FALSE,
language = "pt"
)
Character. City of reference. Defaults to "São Paulo".
Numeric. Year of reference in the format yyyy
. Defaults to
1977
.
Logical. When FALSE
(Default), the function returns the raw
data. If TRUE
, the function returns harmonized data to the same
city, across all the years.
Character. The language of data dictionary to be opened.
Options include c("pt", "en", "es")
.
A "data.frame"
object.