1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/models.R
\name{cepis_address}
\alias{cepis_address}
\title{A CEP and everything the database knows about it}
\description{
The object returned by \code{\link[=cep_lookup]{cep_lookup()}} and by each element of
\code{\link[=cep_lookup_many]{cep_lookup_many()}}. It is a plain list of class \code{cepis_address}, so
\code{address$localidade} and \code{str(address)} work as usual.
\strong{The data fields keep the API's Portuguese names.} Fields the database
does not have for a CEP come back as empty strings, never \code{NA} — that is
what the API returns, and changing it here would create a difference
between reading the JSON and reading this package.
}
\section{Fields}{
\describe{
\item{\code{cep}}{the 8 digits, always unmasked. \code{\link[=formatted_cep]{formatted_cep()}} adds the
mask.}
\item{\code{logradouro}, \code{complemento}, \code{unidade}, \code{bairro}}{the street and
its qualifiers.}
\item{\code{localidade}, \code{uf}, \code{estado}, \code{regiao}}{municipality, state code,
state name, region.}
\item{\code{ibge}, \code{gia}, \code{ddd}, \code{siafi}}{the codes the database carries.}
\item{\code{geo}}{a \link{cepis_geo} object, or \code{NULL} when the database has no
coordinate for that CEP. \code{NULL} and not a row of \code{NA}s because the API
\strong{omits} the whole field in that case (about 43\% of CEPs) rather than
sending null.}
\item{\code{raw}}{the response exactly as it arrived, uninterpreted, so a
field the API grows before this package is updated is not lost.}
}
}
|