R/ipeadata_pkg.R
In gomesleduardo/ipeadata: API Wrapper for 'Ipeadata'
Defines functions
search_series
ipeadata
metadata
available_territories
available_countries
available_subjects
available_series
Documented in
available_countries
available_series
available_subjects
available_territories
ipeadata
metadata
search_series
# ------------------------------------------------------------------ #
# | Brazilian Institute for Applied Economic Research - Ipea | #
# ------------------------------------------------------------------ #
# ------------------------------------------------------------------ #
# | Author: Luiz E. S. Gomes | #
# | Collaborator: Jessyka A. P. Goltara | #
# | Advisor: Erivelton P. Guedes | #
# ------------------------------------------------------------------ #
# ------------------------------------------------------------------ #
# | R package for Ipeadata API database | #
# | Version: 0.1.6 | #
# | January 31, 2022 | #
# ------------------------------------------------------------------ #
# Available series ------------------------------------------------
#' @title List with available series
#'
#' @description Returns a list with available series from Ipeadata API database.
#'
#' @usage available_series(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing Ipeadata code, name, theme, source,
#' frequency, last update and activity status of available series.
#'
#' @note The original language of the available series' names were preserved.
#'
#' @export
#'
#' @importFrom magrittr %<>% %>%
#' @importFrom rlang .data
available_series <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for metadata
url <- 'http://www.ipeadata.gov.br/api/odata4/Metadados/'
# Output NULL
series <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Select variables >
## Sort by source, freq and code >
## Transform in factor >
## Transform in date >
series <-
jsonlite::fromJSON(url, flatten = TRUE)[[2]] %>%
dplyr::as_tibble() %>%
dplyr::select(.data$SERCODIGO, .data$SERNOME, .data$BASNOME,
.data$FNTSIGLA, .data$PERNOME, .data$SERATUALIZACAO,
.data$SERSTATUS) %>%
dplyr::arrange(.data$BASNOME, .data$FNTSIGLA,
.data$PERNOME, .data$SERCODIGO) %>%
dplyr::mutate(FNTSIGLA = as.factor(.data$FNTSIGLA)) %>%
dplyr::mutate(SERATUALIZACAO = lubridate::as_date(.data$SERATUALIZACAO)) %>%
dplyr::mutate(SERSTATUS = as.character(.data$SERSTATUS)) %>%
dplyr::mutate(SERSTATUS = dplyr::if_else(is.na(.data$SERSTATUS),
'',
.data$SERSTATUS))
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(series)) {
if (language == 'en') {
series %<>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Active', 'Inactive', ''))) %>%
dplyr::mutate(PERNOME = iconv(.data$PERNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME,
levels = c('Anual', 'Decenal', 'Diaria', 'Irregular',
'Mensal', 'Quadrienal', 'Quinquenal',
'Semestral', 'Trimestral', 'Nao se aplica'),
labels = c('Yearly', 'Decennial', 'Daily', 'Irregular',
'Monthly', 'Quadrennial', 'Quinquennial',
'Semiannual', 'Quarterly', 'Not applicable'))) %>%
dplyr::mutate(BASNOME = iconv(.data$BASNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(BASNOME = factor(.data$BASNOME,
levels = c('Macroeconomico', 'Regional', 'Social'),
labels = c('Macroeconomic', 'Regional', 'Social'))) %>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Ipeadata Code','Serie Name (PT-BR)', 'Theme',
'Source', 'Frequency','Last Update','Status'))
} else {
series %<>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Ativa', 'Inativa', ''))) %>%
dplyr::mutate(BASNOME = factor(.data$BASNOME)) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME)) %>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Codigo Ipeadata','Nome da Serie', 'Nome da Base', 'Fonte',
'Frequencia','Ultima Atualizacao','Status'))
}
}
} else {
message("The internet connection is unavailable.")
}
series
}
# Available subjects ------------------------------------------------
#' @title List with available subjects
#'
#' @description Returns a list with available subjects from Ipeadata API database.
#'
#' @usage available_subjects(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing code and name of available subjects.
#'
#' @export
available_subjects <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for themes
url <- 'http://www.ipeadata.gov.br/api/odata4/Temas/'
# Output NULL
subjects <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Select variables >
## Sort by code >
## Transform in chr
subjects <-
data.frame(jsonlite::fromJSON(url, flatten = TRUE)[[2]]) %>%
dplyr::as_tibble() %>%
dplyr::select(.data$TEMCODIGO, .data$TEMNOME) %>%
dplyr::arrange(.data$TEMCODIGO) %>%
dplyr::mutate(TEMNOME = as.character(.data$TEMNOME))
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(subjects)) {
# Setting labels in selected language
if (language == 'en') {
subjects %<>%
dplyr::mutate(TEMNOME = iconv(.data$TEMNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(TEMNOME = factor(.data$TEMNOME,
levels = c('Producao', 'Consumo e vendas', 'Moeda e credito', 'Juros', 'Comercio exterior',
'Financas publicas', 'Cambio', 'Contas nacionais', 'Precos', 'Balanco de pagamentos',
'Economia internacional', 'Emprego', 'Salario e renda', 'Populacao', 'Indicadores sociais',
'Projecoes', 'Sinopse macroeconomica', 'Eleicoes', 'Estoque de capital', 'Seguranca Publica',
'Assistencia social', 'Correcao monetaria', 'Avaliacao do governo', 'Vendas',
'Percepcao e expectativa', 'Agropecuaria', 'Educacao', 'Renda', 'Habitacao',
'Geografico', 'Transporte', 'Demografia', 'Desenvolvimento humano', 'Financeiras',
'Mercado de trabalho', 'Saude', 'Deputado Estadual', 'Deputado Federal', 'Governador',
'Prefeito', 'Presidente', 'Senador', 'Vereador', 'Eleitorado', 'IDHm2010',
'IDHm2000', 'IDHm1991', 'Contas Regionais', 'COVID19'),
labels = c('Production', 'Consumption and sales', 'Currency and credit', 'Interest',
'Foreign trade', 'public finances', 'Exchange', 'National Accounts',
'Prices', 'Balance of payments', 'International economy', 'Employment',
'Salary and income', 'Population', 'Social indicators', 'Projections',
'Macroeconomic synopsis', 'Elections', 'Capital stock', 'Public security',
'Social assistance', 'Monetary correction', 'Government evaluation', 'Sales',
'Perception and expectation', 'Agriculture and animal husbandry', 'Education',
'Income', 'Housing', 'Geographical', 'Transport', 'Demography', 'Human development',
'Financial', 'Labor market', 'Health', 'State deputy', 'Federal deputy',
'Governor', 'Mayor', 'President', 'Senator', 'Alderman', 'Electorate', 'mHDI2010',
'mHDI2000', 'mHDI1991', 'Regional Accounts', 'COVID19'))) %>%
purrr::set_names(c('scode', 'sname')) %>%
sjlabelled::set_label(c('Subject Code','Subject Name'))
} else {
subjects %<>%
dplyr::mutate(TEMNOME = factor(.data$TEMNOME)) %>%
purrr::set_names(c('scode', 'sname')) %>%
sjlabelled::set_label(c('Codigo do Tema','Nome do Tema'))
}
}
} else {
message("The internet connection is unavailable.")
}
subjects
}
# Available countries ------------------------------------------------
#' @title List with available countries
#'
#' @description Returns a list with available countries from Ipeadata API database.
#'
#' @usage available_countries(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing 3-letter country code and name of available countries.
#'
#' @export
available_countries <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for countries
url <- 'http://www.ipeadata.gov.br/api/odata4/Paises/'
# Output NULL
countries <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Sort by code
countries <-
jsonlite::fromJSON(url, flatten = TRUE)[[2]] %>%
dplyr::as_tibble() %>%
dplyr::arrange(.data$PAICODIGO)
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(countries)) {
# Setting labels in selected language
if (language == 'en') {
countries %<>%
dplyr::mutate(PAINOME = iconv(.data$PAINOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(PAINOME = factor(.data$PAINOME,
levels = c('Angola', 'Emirados Arabes Unidos', 'Argentina', 'Sudeste Asiatico', 'Australia',
'Austria', 'Belgica', 'Bahamas', 'Bolivia', 'Brasil', 'Canada', 'Suica', 'Chile',
'China', 'Congo', 'Colombia', 'Cabo Verde', 'Republica Tcheca', 'Alemanha',
'Dinamarca', 'Republica Dominicana', 'Argelia', 'Equador', 'Egito', 'Espanha',
'Uniao Europeia', 'Finlandia', 'Franca', 'Gra-Bretanha (Reino Unido, UK)',
'Guine-Bissau', 'Grecia', 'Hong Kong', 'Haiti', 'Hungria', 'Indonesia',
'India', 'Paises industrializados', 'Irlanda', 'Ira', 'Iraque', 'Islandia',
'Israel', 'Italia', 'Japao', 'Coreia do Sul', 'America Latina', 'Santa Lucia',
'Luxemburgo', 'Macau', 'Marrocos', 'Mexico', 'Myanma (Ex-Burma)', 'Mocambique',
'Malasia', 'Nigeria', 'Holanda', 'Noruega', 'Nova Zelandia', 'Peru', 'Filipinas',
'Polonia', 'Portugal', 'Paraguai', 'Qatar', 'Leste Europeu e Russia', 'Romenia',
'Federacao Russa', 'Arabia Saudita', 'Cingapura', 'Sao Tome e Principe', 'Eslovenia',
'Suecia', 'Tailandia', 'Timor Leste (Ex-East Timor)', 'Trinidad and Tobago', 'Taiwan',
'Paises em desenvolvimento', 'Uruguai', 'Estados Unidos', 'Venezuela', 'Mundial',
'Iemen', 'Africa do Sul', 'Zona do Euro'),
labels = c('Angola', 'United Arab Emirates', 'Argentina', 'Southeast Asia', 'Australia', 'Austria',
'Belgium', 'Bahamas', 'Bolivia', 'Brazil', 'Canada', 'Switzerland', 'Chile',
'China', 'Congo', 'Colombia', 'Cape Verde', 'Czech republic', 'Germany',
'Denmark', 'Dominican Republic', 'Algeria', 'Ecuador', 'Egypt', 'Spain',
'European Union', 'Finland', 'France', 'Great Britain (United Kingdom, UK)', 'Guinea Bissau',
'Greece', 'Hong Kong', 'Haiti', 'Hungary', 'Indonesia', 'India', 'Developed countries',
'Ireland', 'Iran', 'Iraq', 'Iceland', 'Israel', 'Italy', 'Japan', 'South Korea',
'Latin America', 'Saint Lucia', 'Luxembourg', 'Macao', 'Morocco', 'Mexico', 'Myanmar',
'Mozambique', 'Malaysia', 'Nigeria', 'Netherlands', 'Norway', 'New Zealand', 'Peru',
'Philippines', 'Poland', 'Portugal', 'Paraguay', 'Qatar', 'Eastern Europe and Russia',
'Romania', 'Russian Federation', 'Saudi Arabia', 'Singapore', 'Sao Tome and Principe',
'Slovenia', 'Sweden', 'Thailand', 'East Timor', 'Trinidad and Tobago', 'Taiwan',
'Developing countries', 'Uruguay','United States of America', 'Venezuela', 'World',
'Yemen', 'South Africa', 'Euro Area'))) %>%
dplyr::mutate(PAINOME = as.character(.data$PAINOME)) %>%
purrr::set_names(c('tcode', 'tname')) %>%
sjlabelled::set_label(c('Country Code','Country Name'))
} else {
countries %<>%
purrr::set_names(c('tcode', 'tname')) %>%
sjlabelled::set_label(c('Codigo do Pais','Nome do Pais'))
}
}
} else {
message("The internet connection is unavailable.")
}
countries
}
# Available territories ------------------------------------------------
#' @title List with available territorial divisions
#'
#' @description Returns a list with available Brazilian territorial
#' divisions from Ipeadata API database.
#'
#' @usage available_territories(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing unit name, code, name and area (in km2)
#' of Brazilian territorial divisions.
#'
#' @export
available_territories <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for territories
url <- 'http://www.ipeadata.gov.br/api/odata4/Territorios/'
# Output NULL
territories <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Select variables >
## Remove NA >
## Sort by uname >
## Rename variables >
## Add subtitles
territories <-
jsonlite::fromJSON(url, flatten = TRUE)[[2]] %>%
dplyr::as_tibble() %>%
dplyr::select(.data$NIVNOME, .data$TERCODIGO, .data$TERNOME, .data$TERAREA) %>%
dplyr::filter(!is.na(.data$TERAREA)) %>%
dplyr::arrange(.data$TERCODIGO)
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(territories)) {
# Setting labels in selected language
if (language == 'en') {
territories %<>%
dplyr::mutate(NIVNOME = iconv(.data$NIVNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = c('Brasil', 'Regioes', 'Estados', 'Mesorregioes', 'Microrregioes',
'Estado/RM', 'Area metropolitana', 'Municipios',
'AMC 91-00', 'AMC 70-00', 'AMC 60-00', 'AMC 40-00',
'AMC 20-00', 'AMC 1872-00'),
labels = c('Brazil', 'Regions', 'States', 'Mesoregions', 'Microregions',
'State/Metropolitan region', 'Metropolitan area', 'Municipality',
'MCA 91-00', 'MCA 70-00', 'MCA 60-00', 'MCA 40-00',
'MCA 20-00', 'MCA 1872-00'), ordered = TRUE)) %>%
dplyr::arrange(.data$NIVNOME) %>%
purrr::set_names(c('uname', 'tcode', 'tname', 'area')) %>%
sjlabelled::set_label(c('Territorial Unit Name',
'Territorial Code','Territorial Name','Area (Km2)'))
} else {
territories %<>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = levels(factor(.data$NIVNOME))[ c(
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == ''),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Brasil'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Regioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estados'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Mesorregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Microrregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estado/RM'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Area metropolitana'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Municipios'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 91-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 70-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 60-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 40-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 20-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 1872-00')
)], ordered = TRUE)) %>%
dplyr::arrange(.data$NIVNOME) %>%
purrr::set_names(c('uname', 'tcode', 'tname', 'area')) %>%
sjlabelled::set_label(c('Nome da Unidade Territorial',
'Codigo Territorial','Nome do Territorio','Area (Km2)'))
}
}
} else {
message("The internet connection is unavailable.")
}
territories
}
# Metadata ------------------------------------------------
#' @title Returns a metadata about the requested series
#'
#' @description Returns a list with metadata information about the requested series.
#'
#' @usage metadata(code, language = c("en", "br"), quiet = FALSE)
#'
#' @param code A character vector with Ipeadata code.
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#' @param quiet Logical. If \code{FALSE} (default), a progress bar is shown.
#'
#' @return A data frame containing Ipeadata code, name, short comment, last update, theme name,
#' source's name and full name, source's URL, frequency, unity, multiplier factor, status,
#' subject code and the country or territorial code of requested series.
#'
#' @examples
#' \dontrun{
#' # Metadata from
#' # "PRECOS12_IPCA12": Extended National Consumer Price Index (IPCA), Brazil
#' meta <- metadata(code = "PRECOS12_IPCA12")
#' }
#'
#' @note The original language of the available series' names and the comments were preserved.
#' The Ipeadata codes may be required by \code{available_series()}.
#'
#' @seealso \code{\link{available_series}}, \code{\link{available_subjects}},
#' \code{\link{available_territories}}
#'
#' @references This R package uses the Ipeadata API.
#' For more information go to \url{http://www.ipeadata.gov.br/}.
#'
#' @export
#'
#' @importFrom utils setTxtProgressBar txtProgressBar
metadata <- function(code, language = c("en", "br"), quiet = FALSE) {
# Check language arg
language <- match.arg(language)
# Output
metadata <- dplyr::as_tibble(data.frame(NULL))
# Progress Bar settings
if (!quiet & (length(code) >= 2)) {
cat("Requesting Ipeadata API <http://www.ipeadata.gov.br/>")
cat('\n')
pb <- txtProgressBar(min = 0, max = length(code), style = 3)
}
update.step <- max(2, floor(length(code)/100))
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
# Retrieve metadata 1 by 1
for (i in 1:length(code)) {
# Check
code0 <- gsub(" ", "_", toupper(code[i]))
# URL for metadata
url <- paste0("http://www.ipeadata.gov.br/api/odata4/Metadados('", code0,"')")
# Extract from JSON
Sys.sleep(.01)
metadata.aux <- jsonlite::fromJSON(url, flatten = TRUE)[[2]]
if (length(metadata.aux) > 0) {
## Starting: Transform to tbl >
## Select variables
metadata.aux %<>%
dplyr::as_tibble() %>%
dplyr::select(- .data$SERNUMERICA)
# Concatenate rows
metadata <- rbind(metadata, metadata.aux)
} else {
warning(paste0("code '", code[i], "' not found"))
}
# Progress Bar
if (!quiet & (i %% update.step == 0 | i == length(code)) & (length(code) >= 2)) {
setTxtProgressBar(pb, i)
}
}
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
} else {
message("The internet connection is unavailable.")
}
# Progress Bar closes
if (!quiet & (length(code) >= 2)) {
close(pb)
}
# Setting labels in selected language
if (nrow(metadata) != 0) {
## Starting: Transform in date >
## Transform in factor >
## Transform in factor >
## Transform in chr >
## Replace missing status
metadata %<>%
dplyr::mutate(SERATUALIZACAO = lubridate::as_date(.data$SERATUALIZACAO)) %>%
dplyr::mutate(FNTSIGLA = as.factor(.data$FNTSIGLA)) %>%
dplyr::mutate(FNTNOME = as.factor(.data$FNTNOME)) %>%
dplyr::mutate(SERSTATUS = as.character(.data$SERSTATUS)) %>%
dplyr::mutate(SERSTATUS = dplyr::if_else(is.na(.data$SERSTATUS), '', .data$SERSTATUS))
# Setting labels in selected language
if (language == 'en') {
metadata %<>%
dplyr::mutate(BASNOME = iconv(.data$BASNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(BASNOME = factor(.data$BASNOME,
levels = c('Macroeconomico', 'Regional', 'Social'),
labels = c('Macroeconomic', 'Regional', 'Social'))) %>%
dplyr::mutate(UNINOME = iconv(.data$UNINOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(UNINOME = factor(.data$UNINOME,
levels = c("-", "Tonelada", "R$", "GWh", "US$", "Euro", "Unidade", "Metro cubico",
"Marco alemao", "Franco frances", "Franco frances", "Libra esterlina",
"Dolar canadense", "Florim holandes", "Franco belga", "Peso argentino",
"Peso chileno", "Peseta espanhola", "Peso novo mexicano", "Peso uruguaio",
"Won sul-coreano", "Cabeca", "Litro", "Duzia", "Cacho", "Ouro", "Iene japones",
"Guarani paraguaio", "Conto de reis", "Km", "Km2", "Mil barris/dia", "NCZ$",
"Ouro oncas", "Pessoa", "R$/MWh", "R$/US$", "Indice", "Porcentagem",
"Habitante", "Ano", "R$, a precos do ano 2000", "(% a.m.)", "(% PIB)",
"(% a.a.)", "(%)", "Metro", "Caixa", "Cr$", "Barril", "Bolivar venezuelano",
"Peso colombiano", "CV", "R$ de 2000/HA", "R$ de 2000/T/KM", "Reis",
"US$ de 2008", "Passageiro-quilometro", "TEU", "Assento-quilometro",
"Tonelada-quilometro", "Hora", "determinado", "R$ Outubro 2009", "Qde.",
"Coroa dinamarquesa", "Dolar cingapurense", "Rupia cingalesa", "Dolar taiwanes",
"Nro", "R$ Janeiro 2012", "Sacas de 60 kg", "R$ Outubro 2012", "R$ de 2013",
"US$ de 2013", "R$ de outubro 2012", "Meses", "R$ de 2010", "R$ Outubro 2013",
"R$ de 2000", "R$ (do ultimo mes)", "R$ Outubro 2014", "R$ de 2014",
"R$ Penultimo mes da serie", "Hectare", "Razao", "Domicilios", "R$ de 2001",
"Yuan", "Grau", "Eleitor", "Voto", "Numero", "(Eleitor)", "(Voto)", "(Unidade)",
"R$/Hrs", "Pence", "MW", "estabelecimento", "R$ de 1999", "Salario Minimo",
"(p.p.)", "Dias", "R$ de 1980", "R$ de 1995", "Conto de reis de 1947",
"US$ de 1995", "Coroa norueguesa", "Coroa sueca", "Franco suico",
"Dolar australiano", "Dolar da nova zelandia", "Rand", "Peso boliviano",
"Peso dominicano", "Sucre", "Sol novo", "Dolar das bahamas", "Franco CFA",
"Dolar de trindad e tobago", "Rial iraniano", "Dinar iraquiano", "Shekel novo",
"Rial saudita", "Libra egipcia", "Rial iemenita", "Dolar de hong kong", "Rupia indiana",
"Rupia", "Ringgit malaio", "Peso filipino", "Dolar de cingapura", "Baht", "Dinar argelino",
"Kuanza reajustavel", "Dirra marroquino", "Naira", "Rublo", "Tolar", "Leu romeno",
"Libra esterlina de 1913", "(Sigla)", "Kg", "Pessoas", "Horas", "US$ FOB", "Libra irlandesa",
"Escudo", "zloty", "US$ de 2005", "MWh", "Tep", "Razao/relacao", "Quantidade", "Real",
"SM", "?C", "mm/mes"),
labels = c("-", "Ton", "R$", "GWh", "US$", "Euro", "Unit", "Cubic meter", "Deutsche mark",
"French franc", "Italian lira", "Pound sterling", "Canadian dollar",
"Dutch guilder", "Belgian franc", "Argentine peso", "Chilean peso", "Spanish peseta",
"Mexican new peso", "Uruguayan peso", "South Korean won", "Head", "Liter", "Dozen",
"Bunch", "Gold", "Japanese yen", "Paraguayan guarani", "Conto de reis", "Km", "Km2",
"Thousand barrels per day", "Brazilian cruzado novo", "Gold per ounce", "Person",
"R$/MWh", "R$/US$", "Index", "Percentage", "Inhabitant", "Year",
"R$, constant prices of 2000", "(% p.m.)", "(% GDP)", "(% p.y.)", "(%)", "Meter",
"Matchbox", "Cr$", "Barrel", "Venezuelan bolivar soberano", "Colombian peso",
"hp", "R$, constant prices of 2000 per hectare",
"R$, constant prices of 2000, R$ T/km", "Reis", "US$, constant prices of 2008",
"Passenger per km", "TEU", "Seat per kilometer", "Tonne per kilometer", "Hour",
"Determined", "R$, constant prices of October 2000", "Quantity", "Danish krone",
"Singapore dollar", "Sri Lankan rupee", "New Taiwan dollar", "Number",
"R$, constant prices of January 2012", "60 kg Sacks",
"R$, constant prices of October 2012", "R$, constant prices of 2013",
"US$, constant prices of 2013", "R$, constant prices of October 2012",
"Month", "R$, constant prices of 2010", "R$, constant prices of October 2013",
"R$, constant prices of 2000", "R$ (last month)",
"R$, constant prices of October 2014", "R$, constant prices of 2014",
"R$ (penultimate month of serie)", "Hectare", "Ratio", "Residence",
"R$, constant prices of 2001", "Yuan", "Degree", "Voter", "Vote", "Number",
"(Eleitor)", "(Voto)", "(Unity)", "R$ per hour", "Pence", "MW", "Establishment",
"R$, constant prices of 1999", "Basic salary", "(p.p.)", "Days", "R$, constant prices of 1980",
"R$, constant prices of 1995", "Conto de reis, constant prices of 1947",
"US$, constant prices of 1995", "Norwegian krone", "Swedish krona", "Swiss franc",
"Australian dollar", "New Zealand dollar", "South African rand", "Bolivian peso",
"Dominican peso", "Ecuadorian sucre", "Peruvian new sol", "Bahamian dollar", "CFA franc",
"Trinidad and Tobago dollar", "Iranian rial", "Iraqi dinar", "Israeli new shekel",
"Saudi riyal", "Egyptian pound", "Egyptian pound", "Hong Kong dollar", "Indian Rupee",
"Rupee", "Malaysian ringgit", "Philippine peso", "Singapore dollar", "Thai baht",
"Algerian dinar", "Angolan readjusted Kwanza", "Moroccan dirham", "Nigerian naira",
"Russian ruble", "Slovenian tolar", "Romanian leu",
"Pound sterling, constant prices of 1913", "(acronyms)", "Kg", "People", "Hour",
"US$ FOB", "Irish pound", "Escudo", "Polish zloty", "US$, constant prices of 2005",
"MWh", "toe", "Ratio/relation", "Quantity", "Real", "Basic salary", "Celsius Degree", "mm/month"))) %>%
dplyr::mutate(PERNOME = iconv(.data$PERNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME,
levels = c('Anual', 'Decenal', 'Diaria', 'Irregular',
'Mensal', 'Quadrienal', 'Quinquenal',
'Semestral', 'Trimestral', 'Nao se aplica'),
labels = c('Yearly', 'Decennial', 'Daily', 'Irregular',
'Monthly', 'Quadrennial', 'Quinquennial',
'Semiannual', 'Quarterly', 'Not applicable'))) %>%
dplyr::mutate(MULNOME = iconv(.data$MULNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(MULNOME = factor(.data$MULNOME,
levels = c('mil', 'milhoes', 'bilhoes', 'centavos',
'milhares', 'trilhoes', 'centenas',
'centena de milhao'),
labels = c( 'Thousand', 'Millions', 'Billions', 'Cents',
'Thousands', 'Trillions', 'Hundreds',
'Hundred million'))) %>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Active', 'Inactive', ''))) %>%
purrr::set_names(c('code', 'name', 'comment', 'lastupdate', 'bname', 'source', 'sourcename',
'sourceurl', 'freq', 'unity', 'mf', 'status',
'scode', 'tcode')) %>%
sjlabelled::set_label(c('Ipeadata Code','Serie Name (PT-BR)', 'Comment (PT-BR)', 'Last Update',
'Theme name', 'Source', 'Source Name', 'Source URL',
'Frequency', 'Unity', 'Multiplier Factor', 'Status',
'Subject Code', 'Country or Territorial Code'))
} else {
metadata %<>%
dplyr::mutate(BASNOME = factor(.data$BASNOME)) %>%
dplyr::mutate(UNINOME = factor(.data$UNINOME)) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME)) %>%
dplyr::mutate(MULNOME = factor(.data$MULNOME)) %>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Ativa', 'Inativa', ''))) %>%
purrr::set_names(c('code', 'name', 'comment', 'lastupdate', 'bname', 'source', 'sourcename',
'sourceurl', 'freq', 'unity', 'mf', 'status',
'scode', 'tcode')) %>%
sjlabelled::set_label(c('Codigo Ipeadata','Nome da Serie (PT-BR)', 'Comentario', 'Ultima Atualizacao',
'Nome da Base', 'Fonte', 'Nome da Fonte', 'URL da Fonte',
'Frequencia', 'Unidade', 'Fator Multiplicador', 'Status',
'Codigo do Tema', 'Codigo de Pais ou Territorial'))
}
}
metadata
}
# Values ------------------------------------------------
#' @title Returns a database about the requested series
#'
#' @description Returns a list with available database about the requested series.
#'
#' @usage ipeadata(code, language = c("en", "br"), quiet = FALSE)
#'
#' @param code A character vector with Ipeadata code.
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#' @param quiet Logical. If \code{FALSE} (default), a progress bar is shown.
#'
#' @return A data frame containing Ipeadata code, date, value, territorial unit name
#' and country or territorial code of requested series.
#'
#'
#' @examples
#' \dontrun{
#' # Data from
#' # "PAN_RRPE": Average real income from effective main work, Brazil
#' data <- ipeadata(code = "PAN_RRPE", language = "br")
#' }
#'
#' @note The Ipeadata codes may be required by \code{available_series()}.
#'
#' @seealso \code{\link{available_series}}, \code{\link{available_territories}}
#'
#' @references This R package uses the Ipeadata API.
#' For more information go to \url{http://www.ipeadata.gov.br/}.
#'
#' @export
#'
#' @importFrom utils setTxtProgressBar txtProgressBar
ipeadata <- function(code, language = c("en", "br"), quiet = FALSE) {
# Check language arg
language <- match.arg(language)
# Output
values <- dplyr::as_tibble(data.frame(NULL))
# Progress Bar settings
if (!quiet & (length(code) >= 2)) {
cat("Requesting Ipeadata API <http://www.ipeadata.gov.br/>")
cat('\n')
pb <- txtProgressBar(min = 0, max = length(code), style = 3)
}
update.step <- max(2, floor(length(code)/100))
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
# Retrieve metadata 1 by 1
for (i in 1:length(code)){
# Check
code0 <- gsub(" ", "_", toupper(code[i]))
# URL for metadata
url <- paste0("http://www.ipeadata.gov.br/api/odata4/ValoresSerie(SERCODIGO='", code0, "')")
# Extract from JSON
Sys.sleep(.01)
values.aux <- dplyr::as_tibble(jsonlite::fromJSON(url, flatten = TRUE)[[2]])
if (length(values.aux) > 0) {
# Sorting by ccode and date
values.aux %<>%
dplyr::mutate(TERCODIGO = as.integer(.data$TERCODIGO)) %>%
dplyr::mutate(NIVNOME = as.factor(.data$NIVNOME)) %>%
dplyr::mutate(VALDATA = lubridate::as_date(.data$VALDATA)) %>%
dplyr::arrange(.data$TERCODIGO, .data$VALDATA)
# Concatenate rows
values <- rbind(values, values.aux)
} else {
warning(paste0("code '", code[i], "' not found"))
}
# Progress Bar
if (!quiet & (i %% update.step == 0 | i == length(code)) & (length(code) >= 2)) {
setTxtProgressBar(pb, i)
}
}
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
} else {
message("The internet connection is unavailable.")
}
# Progress Bar closes
if (!quiet & (length(code) >= 2)) {
close(pb)
}
# Setting labels in selected language
if (nrow(values) != 0) {
## Starting: Remove NA >
## Rename variables >
## Add subtitles >
## Remove duplicates
values %<>%
dplyr::filter(!is.na(.data$VALVALOR)) %>%
dplyr::distinct()
# Setting labels in selected language
if (language == 'en') {
values %<>%
dplyr::mutate(NIVNOME = iconv(.data$NIVNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = c('Brasil', 'Regioes', 'Estados', 'Mesorregioes', 'Microrregioes',
'Estado/RM', 'Area metropolitana', 'Municipios',
'AMC 91-00', 'AMC 70-00', 'AMC 60-00', 'AMC 40-00',
'AMC 20-00', 'AMC 1872-00', ''),
labels = c('Brazil', 'Regions', 'States', 'Mesoregions', 'Microregions',
'State/Metropolitan region', 'Metropolitan area', 'Municipality',
'MCA 91-00', 'MCA 70-00', 'MCA 60-00', 'MCA 40-00',
'MCA 20-00', 'MCA 1872-00', ''), ordered = TRUE)) %>%
purrr::set_names(c('code', 'date', 'value', 'uname', 'tcode')) %>%
sjlabelled::set_label(c('Ipeadata Code', 'Date', 'Value',
'Territorial Unit Name',
'Country or Territorial Code'))
} else {
values %<>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = levels(factor(.data$NIVNOME))[ c(
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == ''),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Brasil'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Regioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estados'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Mesorregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Microrregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estado/RM'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Area metropolitana'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Municipios'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 91-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 70-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 60-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 40-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 20-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 1872-00')
)], ordered = TRUE)) %>%
purrr::set_names(c('code', 'date', 'value', 'uname', 'tcode')) %>%
sjlabelled::set_label(c('Codigo Ipeadata', 'Data', 'Valor',
'Nome da Unidade Territorial',
'Codigo de Pais ou Territorial'))
}
}
values
}
# Search by terms ------------------------------------------------
#' @title List with searched series
#'
#' @description Returns a list with searched series by terms from Ipeadata API database.
#'
#' @usage search_series(terms = NULL, fields = c('name'), language = c("en", "br"))
#'
#' @param terms A character vector with search terms.
#' @param fields A character vector with table fields where matches are sought. See 'Details'.
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @details The \code{fields} options are \code{"code"}, \code{"name"}, \code{"theme"},
#' \code{"source"}, \code{"freq"}, \code{"lastupdate"} and \code{"status"}.
#'
#' @return A data frame containing Ipeadata code, name, theme, source,
#' frequency, last update and activity status of searched series.
#'
#' @note The original language of the available series' names were preserved.
#'
#' @export
search_series <- function(terms = NULL, fields = c('name'), language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# Getting all series
all_series <- available_series(language = language)
# Searching
users_search <- dplyr::as_tibble(NULL)
if (!is.null(terms)) {
for (i in 1:length(fields)) {
for (j in 1:length(terms)) {
users_search %<>%
dplyr::bind_rows(users_search,
all_series %>%
dplyr::filter_(~ stringr::str_detect(string = get(fields[i]), pattern = terms[j]))) %>%
dplyr::distinct()
}
}
} else {
users_search <- all_series
}
# Setting labels in selected language
if (language == 'en') {
users_search %<>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Ipeadata Code','Serie Name (PT-BR)', 'Theme',
'Source', 'Frequency','Last Update','Status'))
} else {
users_search %<>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Codigo Ipeadata','Nome da Serie', 'Nome da Base', 'Fonte',
'Frequencia','Ultima Atualizacao','Status'))
}
users_search
}
# Change frequency ------------------------------------------------
gomesleduardo/ipeadata documentation built on Feb. 4, 2022, 4:39 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Defines functions search_series ipeadata metadata available_territories available_countries available_subjects available_series
Documented in available_countries available_series available_subjects available_territories ipeadata metadata search_series
# ------------------------------------------------------------------ #
# | Brazilian Institute for Applied Economic Research - Ipea | #
# ------------------------------------------------------------------ #
# ------------------------------------------------------------------ #
# | Author: Luiz E. S. Gomes | #
# | Collaborator: Jessyka A. P. Goltara | #
# | Advisor: Erivelton P. Guedes | #
# ------------------------------------------------------------------ #
# ------------------------------------------------------------------ #
# | R package for Ipeadata API database | #
# | Version: 0.1.6 | #
# | January 31, 2022 | #
# ------------------------------------------------------------------ #
# Available series ------------------------------------------------
#' @title List with available series
#'
#' @description Returns a list with available series from Ipeadata API database.
#'
#' @usage available_series(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing Ipeadata code, name, theme, source,
#' frequency, last update and activity status of available series.
#'
#' @note The original language of the available series' names were preserved.
#'
#' @export
#'
#' @importFrom magrittr %<>% %>%
#' @importFrom rlang .data
available_series <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for metadata
url <- 'http://www.ipeadata.gov.br/api/odata4/Metadados/'
# Output NULL
series <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Select variables >
## Sort by source, freq and code >
## Transform in factor >
## Transform in date >
series <-
jsonlite::fromJSON(url, flatten = TRUE)[[2]] %>%
dplyr::as_tibble() %>%
dplyr::select(.data$SERCODIGO, .data$SERNOME, .data$BASNOME,
.data$FNTSIGLA, .data$PERNOME, .data$SERATUALIZACAO,
.data$SERSTATUS) %>%
dplyr::arrange(.data$BASNOME, .data$FNTSIGLA,
.data$PERNOME, .data$SERCODIGO) %>%
dplyr::mutate(FNTSIGLA = as.factor(.data$FNTSIGLA)) %>%
dplyr::mutate(SERATUALIZACAO = lubridate::as_date(.data$SERATUALIZACAO)) %>%
dplyr::mutate(SERSTATUS = as.character(.data$SERSTATUS)) %>%
dplyr::mutate(SERSTATUS = dplyr::if_else(is.na(.data$SERSTATUS),
'',
.data$SERSTATUS))
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(series)) {
if (language == 'en') {
series %<>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Active', 'Inactive', ''))) %>%
dplyr::mutate(PERNOME = iconv(.data$PERNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME,
levels = c('Anual', 'Decenal', 'Diaria', 'Irregular',
'Mensal', 'Quadrienal', 'Quinquenal',
'Semestral', 'Trimestral', 'Nao se aplica'),
labels = c('Yearly', 'Decennial', 'Daily', 'Irregular',
'Monthly', 'Quadrennial', 'Quinquennial',
'Semiannual', 'Quarterly', 'Not applicable'))) %>%
dplyr::mutate(BASNOME = iconv(.data$BASNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(BASNOME = factor(.data$BASNOME,
levels = c('Macroeconomico', 'Regional', 'Social'),
labels = c('Macroeconomic', 'Regional', 'Social'))) %>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Ipeadata Code','Serie Name (PT-BR)', 'Theme',
'Source', 'Frequency','Last Update','Status'))
} else {
series %<>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Ativa', 'Inativa', ''))) %>%
dplyr::mutate(BASNOME = factor(.data$BASNOME)) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME)) %>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Codigo Ipeadata','Nome da Serie', 'Nome da Base', 'Fonte',
'Frequencia','Ultima Atualizacao','Status'))
}
}
} else {
message("The internet connection is unavailable.")
}
series
}
# Available subjects ------------------------------------------------
#' @title List with available subjects
#'
#' @description Returns a list with available subjects from Ipeadata API database.
#'
#' @usage available_subjects(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing code and name of available subjects.
#'
#' @export
available_subjects <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for themes
url <- 'http://www.ipeadata.gov.br/api/odata4/Temas/'
# Output NULL
subjects <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Select variables >
## Sort by code >
## Transform in chr
subjects <-
data.frame(jsonlite::fromJSON(url, flatten = TRUE)[[2]]) %>%
dplyr::as_tibble() %>%
dplyr::select(.data$TEMCODIGO, .data$TEMNOME) %>%
dplyr::arrange(.data$TEMCODIGO) %>%
dplyr::mutate(TEMNOME = as.character(.data$TEMNOME))
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(subjects)) {
# Setting labels in selected language
if (language == 'en') {
subjects %<>%
dplyr::mutate(TEMNOME = iconv(.data$TEMNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(TEMNOME = factor(.data$TEMNOME,
levels = c('Producao', 'Consumo e vendas', 'Moeda e credito', 'Juros', 'Comercio exterior',
'Financas publicas', 'Cambio', 'Contas nacionais', 'Precos', 'Balanco de pagamentos',
'Economia internacional', 'Emprego', 'Salario e renda', 'Populacao', 'Indicadores sociais',
'Projecoes', 'Sinopse macroeconomica', 'Eleicoes', 'Estoque de capital', 'Seguranca Publica',
'Assistencia social', 'Correcao monetaria', 'Avaliacao do governo', 'Vendas',
'Percepcao e expectativa', 'Agropecuaria', 'Educacao', 'Renda', 'Habitacao',
'Geografico', 'Transporte', 'Demografia', 'Desenvolvimento humano', 'Financeiras',
'Mercado de trabalho', 'Saude', 'Deputado Estadual', 'Deputado Federal', 'Governador',
'Prefeito', 'Presidente', 'Senador', 'Vereador', 'Eleitorado', 'IDHm2010',
'IDHm2000', 'IDHm1991', 'Contas Regionais', 'COVID19'),
labels = c('Production', 'Consumption and sales', 'Currency and credit', 'Interest',
'Foreign trade', 'public finances', 'Exchange', 'National Accounts',
'Prices', 'Balance of payments', 'International economy', 'Employment',
'Salary and income', 'Population', 'Social indicators', 'Projections',
'Macroeconomic synopsis', 'Elections', 'Capital stock', 'Public security',
'Social assistance', 'Monetary correction', 'Government evaluation', 'Sales',
'Perception and expectation', 'Agriculture and animal husbandry', 'Education',
'Income', 'Housing', 'Geographical', 'Transport', 'Demography', 'Human development',
'Financial', 'Labor market', 'Health', 'State deputy', 'Federal deputy',
'Governor', 'Mayor', 'President', 'Senator', 'Alderman', 'Electorate', 'mHDI2010',
'mHDI2000', 'mHDI1991', 'Regional Accounts', 'COVID19'))) %>%
purrr::set_names(c('scode', 'sname')) %>%
sjlabelled::set_label(c('Subject Code','Subject Name'))
} else {
subjects %<>%
dplyr::mutate(TEMNOME = factor(.data$TEMNOME)) %>%
purrr::set_names(c('scode', 'sname')) %>%
sjlabelled::set_label(c('Codigo do Tema','Nome do Tema'))
}
}
} else {
message("The internet connection is unavailable.")
}
subjects
}
# Available countries ------------------------------------------------
#' @title List with available countries
#'
#' @description Returns a list with available countries from Ipeadata API database.
#'
#' @usage available_countries(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing 3-letter country code and name of available countries.
#'
#' @export
available_countries <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for countries
url <- 'http://www.ipeadata.gov.br/api/odata4/Paises/'
# Output NULL
countries <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Sort by code
countries <-
jsonlite::fromJSON(url, flatten = TRUE)[[2]] %>%
dplyr::as_tibble() %>%
dplyr::arrange(.data$PAICODIGO)
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(countries)) {
# Setting labels in selected language
if (language == 'en') {
countries %<>%
dplyr::mutate(PAINOME = iconv(.data$PAINOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(PAINOME = factor(.data$PAINOME,
levels = c('Angola', 'Emirados Arabes Unidos', 'Argentina', 'Sudeste Asiatico', 'Australia',
'Austria', 'Belgica', 'Bahamas', 'Bolivia', 'Brasil', 'Canada', 'Suica', 'Chile',
'China', 'Congo', 'Colombia', 'Cabo Verde', 'Republica Tcheca', 'Alemanha',
'Dinamarca', 'Republica Dominicana', 'Argelia', 'Equador', 'Egito', 'Espanha',
'Uniao Europeia', 'Finlandia', 'Franca', 'Gra-Bretanha (Reino Unido, UK)',
'Guine-Bissau', 'Grecia', 'Hong Kong', 'Haiti', 'Hungria', 'Indonesia',
'India', 'Paises industrializados', 'Irlanda', 'Ira', 'Iraque', 'Islandia',
'Israel', 'Italia', 'Japao', 'Coreia do Sul', 'America Latina', 'Santa Lucia',
'Luxemburgo', 'Macau', 'Marrocos', 'Mexico', 'Myanma (Ex-Burma)', 'Mocambique',
'Malasia', 'Nigeria', 'Holanda', 'Noruega', 'Nova Zelandia', 'Peru', 'Filipinas',
'Polonia', 'Portugal', 'Paraguai', 'Qatar', 'Leste Europeu e Russia', 'Romenia',
'Federacao Russa', 'Arabia Saudita', 'Cingapura', 'Sao Tome e Principe', 'Eslovenia',
'Suecia', 'Tailandia', 'Timor Leste (Ex-East Timor)', 'Trinidad and Tobago', 'Taiwan',
'Paises em desenvolvimento', 'Uruguai', 'Estados Unidos', 'Venezuela', 'Mundial',
'Iemen', 'Africa do Sul', 'Zona do Euro'),
labels = c('Angola', 'United Arab Emirates', 'Argentina', 'Southeast Asia', 'Australia', 'Austria',
'Belgium', 'Bahamas', 'Bolivia', 'Brazil', 'Canada', 'Switzerland', 'Chile',
'China', 'Congo', 'Colombia', 'Cape Verde', 'Czech republic', 'Germany',
'Denmark', 'Dominican Republic', 'Algeria', 'Ecuador', 'Egypt', 'Spain',
'European Union', 'Finland', 'France', 'Great Britain (United Kingdom, UK)', 'Guinea Bissau',
'Greece', 'Hong Kong', 'Haiti', 'Hungary', 'Indonesia', 'India', 'Developed countries',
'Ireland', 'Iran', 'Iraq', 'Iceland', 'Israel', 'Italy', 'Japan', 'South Korea',
'Latin America', 'Saint Lucia', 'Luxembourg', 'Macao', 'Morocco', 'Mexico', 'Myanmar',
'Mozambique', 'Malaysia', 'Nigeria', 'Netherlands', 'Norway', 'New Zealand', 'Peru',
'Philippines', 'Poland', 'Portugal', 'Paraguay', 'Qatar', 'Eastern Europe and Russia',
'Romania', 'Russian Federation', 'Saudi Arabia', 'Singapore', 'Sao Tome and Principe',
'Slovenia', 'Sweden', 'Thailand', 'East Timor', 'Trinidad and Tobago', 'Taiwan',
'Developing countries', 'Uruguay','United States of America', 'Venezuela', 'World',
'Yemen', 'South Africa', 'Euro Area'))) %>%
dplyr::mutate(PAINOME = as.character(.data$PAINOME)) %>%
purrr::set_names(c('tcode', 'tname')) %>%
sjlabelled::set_label(c('Country Code','Country Name'))
} else {
countries %<>%
purrr::set_names(c('tcode', 'tname')) %>%
sjlabelled::set_label(c('Codigo do Pais','Nome do Pais'))
}
}
} else {
message("The internet connection is unavailable.")
}
countries
}
# Available territories ------------------------------------------------
#' @title List with available territorial divisions
#'
#' @description Returns a list with available Brazilian territorial
#' divisions from Ipeadata API database.
#'
#' @usage available_territories(language = c("en", "br"))
#'
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @return A data frame containing unit name, code, name and area (in km2)
#' of Brazilian territorial divisions.
#'
#' @export
available_territories <- function(language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# URL for territories
url <- 'http://www.ipeadata.gov.br/api/odata4/Territorios/'
# Output NULL
territories <- NULL
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
## Starting: Extract from JSON >
## Transform to tbl >
## Select variables >
## Remove NA >
## Sort by uname >
## Rename variables >
## Add subtitles
territories <-
jsonlite::fromJSON(url, flatten = TRUE)[[2]] %>%
dplyr::as_tibble() %>%
dplyr::select(.data$NIVNOME, .data$TERCODIGO, .data$TERNOME, .data$TERAREA) %>%
dplyr::filter(!is.na(.data$TERAREA)) %>%
dplyr::arrange(.data$TERCODIGO)
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
# Setting labels in selected language
if (!is.null(territories)) {
# Setting labels in selected language
if (language == 'en') {
territories %<>%
dplyr::mutate(NIVNOME = iconv(.data$NIVNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = c('Brasil', 'Regioes', 'Estados', 'Mesorregioes', 'Microrregioes',
'Estado/RM', 'Area metropolitana', 'Municipios',
'AMC 91-00', 'AMC 70-00', 'AMC 60-00', 'AMC 40-00',
'AMC 20-00', 'AMC 1872-00'),
labels = c('Brazil', 'Regions', 'States', 'Mesoregions', 'Microregions',
'State/Metropolitan region', 'Metropolitan area', 'Municipality',
'MCA 91-00', 'MCA 70-00', 'MCA 60-00', 'MCA 40-00',
'MCA 20-00', 'MCA 1872-00'), ordered = TRUE)) %>%
dplyr::arrange(.data$NIVNOME) %>%
purrr::set_names(c('uname', 'tcode', 'tname', 'area')) %>%
sjlabelled::set_label(c('Territorial Unit Name',
'Territorial Code','Territorial Name','Area (Km2)'))
} else {
territories %<>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = levels(factor(.data$NIVNOME))[ c(
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == ''),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Brasil'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Regioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estados'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Mesorregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Microrregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estado/RM'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Area metropolitana'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Municipios'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 91-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 70-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 60-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 40-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 20-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 1872-00')
)], ordered = TRUE)) %>%
dplyr::arrange(.data$NIVNOME) %>%
purrr::set_names(c('uname', 'tcode', 'tname', 'area')) %>%
sjlabelled::set_label(c('Nome da Unidade Territorial',
'Codigo Territorial','Nome do Territorio','Area (Km2)'))
}
}
} else {
message("The internet connection is unavailable.")
}
territories
}
# Metadata ------------------------------------------------
#' @title Returns a metadata about the requested series
#'
#' @description Returns a list with metadata information about the requested series.
#'
#' @usage metadata(code, language = c("en", "br"), quiet = FALSE)
#'
#' @param code A character vector with Ipeadata code.
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#' @param quiet Logical. If \code{FALSE} (default), a progress bar is shown.
#'
#' @return A data frame containing Ipeadata code, name, short comment, last update, theme name,
#' source's name and full name, source's URL, frequency, unity, multiplier factor, status,
#' subject code and the country or territorial code of requested series.
#'
#' @examples
#' \dontrun{
#' # Metadata from
#' # "PRECOS12_IPCA12": Extended National Consumer Price Index (IPCA), Brazil
#' meta <- metadata(code = "PRECOS12_IPCA12")
#' }
#'
#' @note The original language of the available series' names and the comments were preserved.
#' The Ipeadata codes may be required by \code{available_series()}.
#'
#' @seealso \code{\link{available_series}}, \code{\link{available_subjects}},
#' \code{\link{available_territories}}
#'
#' @references This R package uses the Ipeadata API.
#' For more information go to \url{http://www.ipeadata.gov.br/}.
#'
#' @export
#'
#' @importFrom utils setTxtProgressBar txtProgressBar
metadata <- function(code, language = c("en", "br"), quiet = FALSE) {
# Check language arg
language <- match.arg(language)
# Output
metadata <- dplyr::as_tibble(data.frame(NULL))
# Progress Bar settings
if (!quiet & (length(code) >= 2)) {
cat("Requesting Ipeadata API <http://www.ipeadata.gov.br/>")
cat('\n')
pb <- txtProgressBar(min = 0, max = length(code), style = 3)
}
update.step <- max(2, floor(length(code)/100))
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
# Retrieve metadata 1 by 1
for (i in 1:length(code)) {
# Check
code0 <- gsub(" ", "_", toupper(code[i]))
# URL for metadata
url <- paste0("http://www.ipeadata.gov.br/api/odata4/Metadados('", code0,"')")
# Extract from JSON
Sys.sleep(.01)
metadata.aux <- jsonlite::fromJSON(url, flatten = TRUE)[[2]]
if (length(metadata.aux) > 0) {
## Starting: Transform to tbl >
## Select variables
metadata.aux %<>%
dplyr::as_tibble() %>%
dplyr::select(- .data$SERNUMERICA)
# Concatenate rows
metadata <- rbind(metadata, metadata.aux)
} else {
warning(paste0("code '", code[i], "' not found"))
}
# Progress Bar
if (!quiet & (i %% update.step == 0 | i == length(code)) & (length(code) >= 2)) {
setTxtProgressBar(pb, i)
}
}
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
} else {
message("The internet connection is unavailable.")
}
# Progress Bar closes
if (!quiet & (length(code) >= 2)) {
close(pb)
}
# Setting labels in selected language
if (nrow(metadata) != 0) {
## Starting: Transform in date >
## Transform in factor >
## Transform in factor >
## Transform in chr >
## Replace missing status
metadata %<>%
dplyr::mutate(SERATUALIZACAO = lubridate::as_date(.data$SERATUALIZACAO)) %>%
dplyr::mutate(FNTSIGLA = as.factor(.data$FNTSIGLA)) %>%
dplyr::mutate(FNTNOME = as.factor(.data$FNTNOME)) %>%
dplyr::mutate(SERSTATUS = as.character(.data$SERSTATUS)) %>%
dplyr::mutate(SERSTATUS = dplyr::if_else(is.na(.data$SERSTATUS), '', .data$SERSTATUS))
# Setting labels in selected language
if (language == 'en') {
metadata %<>%
dplyr::mutate(BASNOME = iconv(.data$BASNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(BASNOME = factor(.data$BASNOME,
levels = c('Macroeconomico', 'Regional', 'Social'),
labels = c('Macroeconomic', 'Regional', 'Social'))) %>%
dplyr::mutate(UNINOME = iconv(.data$UNINOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(UNINOME = factor(.data$UNINOME,
levels = c("-", "Tonelada", "R$", "GWh", "US$", "Euro", "Unidade", "Metro cubico",
"Marco alemao", "Franco frances", "Franco frances", "Libra esterlina",
"Dolar canadense", "Florim holandes", "Franco belga", "Peso argentino",
"Peso chileno", "Peseta espanhola", "Peso novo mexicano", "Peso uruguaio",
"Won sul-coreano", "Cabeca", "Litro", "Duzia", "Cacho", "Ouro", "Iene japones",
"Guarani paraguaio", "Conto de reis", "Km", "Km2", "Mil barris/dia", "NCZ$",
"Ouro oncas", "Pessoa", "R$/MWh", "R$/US$", "Indice", "Porcentagem",
"Habitante", "Ano", "R$, a precos do ano 2000", "(% a.m.)", "(% PIB)",
"(% a.a.)", "(%)", "Metro", "Caixa", "Cr$", "Barril", "Bolivar venezuelano",
"Peso colombiano", "CV", "R$ de 2000/HA", "R$ de 2000/T/KM", "Reis",
"US$ de 2008", "Passageiro-quilometro", "TEU", "Assento-quilometro",
"Tonelada-quilometro", "Hora", "determinado", "R$ Outubro 2009", "Qde.",
"Coroa dinamarquesa", "Dolar cingapurense", "Rupia cingalesa", "Dolar taiwanes",
"Nro", "R$ Janeiro 2012", "Sacas de 60 kg", "R$ Outubro 2012", "R$ de 2013",
"US$ de 2013", "R$ de outubro 2012", "Meses", "R$ de 2010", "R$ Outubro 2013",
"R$ de 2000", "R$ (do ultimo mes)", "R$ Outubro 2014", "R$ de 2014",
"R$ Penultimo mes da serie", "Hectare", "Razao", "Domicilios", "R$ de 2001",
"Yuan", "Grau", "Eleitor", "Voto", "Numero", "(Eleitor)", "(Voto)", "(Unidade)",
"R$/Hrs", "Pence", "MW", "estabelecimento", "R$ de 1999", "Salario Minimo",
"(p.p.)", "Dias", "R$ de 1980", "R$ de 1995", "Conto de reis de 1947",
"US$ de 1995", "Coroa norueguesa", "Coroa sueca", "Franco suico",
"Dolar australiano", "Dolar da nova zelandia", "Rand", "Peso boliviano",
"Peso dominicano", "Sucre", "Sol novo", "Dolar das bahamas", "Franco CFA",
"Dolar de trindad e tobago", "Rial iraniano", "Dinar iraquiano", "Shekel novo",
"Rial saudita", "Libra egipcia", "Rial iemenita", "Dolar de hong kong", "Rupia indiana",
"Rupia", "Ringgit malaio", "Peso filipino", "Dolar de cingapura", "Baht", "Dinar argelino",
"Kuanza reajustavel", "Dirra marroquino", "Naira", "Rublo", "Tolar", "Leu romeno",
"Libra esterlina de 1913", "(Sigla)", "Kg", "Pessoas", "Horas", "US$ FOB", "Libra irlandesa",
"Escudo", "zloty", "US$ de 2005", "MWh", "Tep", "Razao/relacao", "Quantidade", "Real",
"SM", "?C", "mm/mes"),
labels = c("-", "Ton", "R$", "GWh", "US$", "Euro", "Unit", "Cubic meter", "Deutsche mark",
"French franc", "Italian lira", "Pound sterling", "Canadian dollar",
"Dutch guilder", "Belgian franc", "Argentine peso", "Chilean peso", "Spanish peseta",
"Mexican new peso", "Uruguayan peso", "South Korean won", "Head", "Liter", "Dozen",
"Bunch", "Gold", "Japanese yen", "Paraguayan guarani", "Conto de reis", "Km", "Km2",
"Thousand barrels per day", "Brazilian cruzado novo", "Gold per ounce", "Person",
"R$/MWh", "R$/US$", "Index", "Percentage", "Inhabitant", "Year",
"R$, constant prices of 2000", "(% p.m.)", "(% GDP)", "(% p.y.)", "(%)", "Meter",
"Matchbox", "Cr$", "Barrel", "Venezuelan bolivar soberano", "Colombian peso",
"hp", "R$, constant prices of 2000 per hectare",
"R$, constant prices of 2000, R$ T/km", "Reis", "US$, constant prices of 2008",
"Passenger per km", "TEU", "Seat per kilometer", "Tonne per kilometer", "Hour",
"Determined", "R$, constant prices of October 2000", "Quantity", "Danish krone",
"Singapore dollar", "Sri Lankan rupee", "New Taiwan dollar", "Number",
"R$, constant prices of January 2012", "60 kg Sacks",
"R$, constant prices of October 2012", "R$, constant prices of 2013",
"US$, constant prices of 2013", "R$, constant prices of October 2012",
"Month", "R$, constant prices of 2010", "R$, constant prices of October 2013",
"R$, constant prices of 2000", "R$ (last month)",
"R$, constant prices of October 2014", "R$, constant prices of 2014",
"R$ (penultimate month of serie)", "Hectare", "Ratio", "Residence",
"R$, constant prices of 2001", "Yuan", "Degree", "Voter", "Vote", "Number",
"(Eleitor)", "(Voto)", "(Unity)", "R$ per hour", "Pence", "MW", "Establishment",
"R$, constant prices of 1999", "Basic salary", "(p.p.)", "Days", "R$, constant prices of 1980",
"R$, constant prices of 1995", "Conto de reis, constant prices of 1947",
"US$, constant prices of 1995", "Norwegian krone", "Swedish krona", "Swiss franc",
"Australian dollar", "New Zealand dollar", "South African rand", "Bolivian peso",
"Dominican peso", "Ecuadorian sucre", "Peruvian new sol", "Bahamian dollar", "CFA franc",
"Trinidad and Tobago dollar", "Iranian rial", "Iraqi dinar", "Israeli new shekel",
"Saudi riyal", "Egyptian pound", "Egyptian pound", "Hong Kong dollar", "Indian Rupee",
"Rupee", "Malaysian ringgit", "Philippine peso", "Singapore dollar", "Thai baht",
"Algerian dinar", "Angolan readjusted Kwanza", "Moroccan dirham", "Nigerian naira",
"Russian ruble", "Slovenian tolar", "Romanian leu",
"Pound sterling, constant prices of 1913", "(acronyms)", "Kg", "People", "Hour",
"US$ FOB", "Irish pound", "Escudo", "Polish zloty", "US$, constant prices of 2005",
"MWh", "toe", "Ratio/relation", "Quantity", "Real", "Basic salary", "Celsius Degree", "mm/month"))) %>%
dplyr::mutate(PERNOME = iconv(.data$PERNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME,
levels = c('Anual', 'Decenal', 'Diaria', 'Irregular',
'Mensal', 'Quadrienal', 'Quinquenal',
'Semestral', 'Trimestral', 'Nao se aplica'),
labels = c('Yearly', 'Decennial', 'Daily', 'Irregular',
'Monthly', 'Quadrennial', 'Quinquennial',
'Semiannual', 'Quarterly', 'Not applicable'))) %>%
dplyr::mutate(MULNOME = iconv(.data$MULNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(MULNOME = factor(.data$MULNOME,
levels = c('mil', 'milhoes', 'bilhoes', 'centavos',
'milhares', 'trilhoes', 'centenas',
'centena de milhao'),
labels = c( 'Thousand', 'Millions', 'Billions', 'Cents',
'Thousands', 'Trillions', 'Hundreds',
'Hundred million'))) %>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Active', 'Inactive', ''))) %>%
purrr::set_names(c('code', 'name', 'comment', 'lastupdate', 'bname', 'source', 'sourcename',
'sourceurl', 'freq', 'unity', 'mf', 'status',
'scode', 'tcode')) %>%
sjlabelled::set_label(c('Ipeadata Code','Serie Name (PT-BR)', 'Comment (PT-BR)', 'Last Update',
'Theme name', 'Source', 'Source Name', 'Source URL',
'Frequency', 'Unity', 'Multiplier Factor', 'Status',
'Subject Code', 'Country or Territorial Code'))
} else {
metadata %<>%
dplyr::mutate(BASNOME = factor(.data$BASNOME)) %>%
dplyr::mutate(UNINOME = factor(.data$UNINOME)) %>%
dplyr::mutate(PERNOME = factor(.data$PERNOME)) %>%
dplyr::mutate(MULNOME = factor(.data$MULNOME)) %>%
dplyr::mutate(SERSTATUS = factor(.data$SERSTATUS,
levels = c('A', 'I', ''),
labels = c('Ativa', 'Inativa', ''))) %>%
purrr::set_names(c('code', 'name', 'comment', 'lastupdate', 'bname', 'source', 'sourcename',
'sourceurl', 'freq', 'unity', 'mf', 'status',
'scode', 'tcode')) %>%
sjlabelled::set_label(c('Codigo Ipeadata','Nome da Serie (PT-BR)', 'Comentario', 'Ultima Atualizacao',
'Nome da Base', 'Fonte', 'Nome da Fonte', 'URL da Fonte',
'Frequencia', 'Unidade', 'Fator Multiplicador', 'Status',
'Codigo do Tema', 'Codigo de Pais ou Territorial'))
}
}
metadata
}
# Values ------------------------------------------------
#' @title Returns a database about the requested series
#'
#' @description Returns a list with available database about the requested series.
#'
#' @usage ipeadata(code, language = c("en", "br"), quiet = FALSE)
#'
#' @param code A character vector with Ipeadata code.
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#' @param quiet Logical. If \code{FALSE} (default), a progress bar is shown.
#'
#' @return A data frame containing Ipeadata code, date, value, territorial unit name
#' and country or territorial code of requested series.
#'
#'
#' @examples
#' \dontrun{
#' # Data from
#' # "PAN_RRPE": Average real income from effective main work, Brazil
#' data <- ipeadata(code = "PAN_RRPE", language = "br")
#' }
#'
#' @note The Ipeadata codes may be required by \code{available_series()}.
#'
#' @seealso \code{\link{available_series}}, \code{\link{available_territories}}
#'
#' @references This R package uses the Ipeadata API.
#' For more information go to \url{http://www.ipeadata.gov.br/}.
#'
#' @export
#'
#' @importFrom utils setTxtProgressBar txtProgressBar
ipeadata <- function(code, language = c("en", "br"), quiet = FALSE) {
# Check language arg
language <- match.arg(language)
# Output
values <- dplyr::as_tibble(data.frame(NULL))
# Progress Bar settings
if (!quiet & (length(code) >= 2)) {
cat("Requesting Ipeadata API <http://www.ipeadata.gov.br/>")
cat('\n')
pb <- txtProgressBar(min = 0, max = length(code), style = 3)
}
update.step <- max(2, floor(length(code)/100))
# Test internet connection
if (curl::has_internet()) {
Sys.sleep(.01)
tryCatch({
# Retrieve metadata 1 by 1
for (i in 1:length(code)){
# Check
code0 <- gsub(" ", "_", toupper(code[i]))
# URL for metadata
url <- paste0("http://www.ipeadata.gov.br/api/odata4/ValoresSerie(SERCODIGO='", code0, "')")
# Extract from JSON
Sys.sleep(.01)
values.aux <- dplyr::as_tibble(jsonlite::fromJSON(url, flatten = TRUE)[[2]])
if (length(values.aux) > 0) {
# Sorting by ccode and date
values.aux %<>%
dplyr::mutate(TERCODIGO = as.integer(.data$TERCODIGO)) %>%
dplyr::mutate(NIVNOME = as.factor(.data$NIVNOME)) %>%
dplyr::mutate(VALDATA = lubridate::as_date(.data$VALDATA)) %>%
dplyr::arrange(.data$TERCODIGO, .data$VALDATA)
# Concatenate rows
values <- rbind(values, values.aux)
} else {
warning(paste0("code '", code[i], "' not found"))
}
# Progress Bar
if (!quiet & (i %% update.step == 0 | i == length(code)) & (length(code) >= 2)) {
setTxtProgressBar(pb, i)
}
}
}, error = function(e){cat("ERROR :", conditionMessage(e), "\n")})
} else {
message("The internet connection is unavailable.")
}
# Progress Bar closes
if (!quiet & (length(code) >= 2)) {
close(pb)
}
# Setting labels in selected language
if (nrow(values) != 0) {
## Starting: Remove NA >
## Rename variables >
## Add subtitles >
## Remove duplicates
values %<>%
dplyr::filter(!is.na(.data$VALVALOR)) %>%
dplyr::distinct()
# Setting labels in selected language
if (language == 'en') {
values %<>%
dplyr::mutate(NIVNOME = iconv(.data$NIVNOME, 'UTF-8', 'ASCII//TRANSLIT')) %>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = c('Brasil', 'Regioes', 'Estados', 'Mesorregioes', 'Microrregioes',
'Estado/RM', 'Area metropolitana', 'Municipios',
'AMC 91-00', 'AMC 70-00', 'AMC 60-00', 'AMC 40-00',
'AMC 20-00', 'AMC 1872-00', ''),
labels = c('Brazil', 'Regions', 'States', 'Mesoregions', 'Microregions',
'State/Metropolitan region', 'Metropolitan area', 'Municipality',
'MCA 91-00', 'MCA 70-00', 'MCA 60-00', 'MCA 40-00',
'MCA 20-00', 'MCA 1872-00', ''), ordered = TRUE)) %>%
purrr::set_names(c('code', 'date', 'value', 'uname', 'tcode')) %>%
sjlabelled::set_label(c('Ipeadata Code', 'Date', 'Value',
'Territorial Unit Name',
'Country or Territorial Code'))
} else {
values %<>%
dplyr::mutate(NIVNOME = factor(.data$NIVNOME,
levels = levels(factor(.data$NIVNOME))[ c(
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == ''),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Brasil'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Regioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estados'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Mesorregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Microrregioes'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Estado/RM'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Area metropolitana'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'Municipios'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 91-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 70-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 60-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 40-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 20-00'),
which(iconv(levels(factor(.data$NIVNOME)), 'UTF-8', 'ASCII//TRANSLIT') == 'AMC 1872-00')
)], ordered = TRUE)) %>%
purrr::set_names(c('code', 'date', 'value', 'uname', 'tcode')) %>%
sjlabelled::set_label(c('Codigo Ipeadata', 'Data', 'Valor',
'Nome da Unidade Territorial',
'Codigo de Pais ou Territorial'))
}
}
values
}
# Search by terms ------------------------------------------------
#' @title List with searched series
#'
#' @description Returns a list with searched series by terms from Ipeadata API database.
#'
#' @usage search_series(terms = NULL, fields = c('name'), language = c("en", "br"))
#'
#' @param terms A character vector with search terms.
#' @param fields A character vector with table fields where matches are sought. See 'Details'.
#' @param language String specifying the selected language. Language options are
#' English (\code{"en"}, default) and Brazilian Portuguese (\code{"br"}).
#'
#' @details The \code{fields} options are \code{"code"}, \code{"name"}, \code{"theme"},
#' \code{"source"}, \code{"freq"}, \code{"lastupdate"} and \code{"status"}.
#'
#' @return A data frame containing Ipeadata code, name, theme, source,
#' frequency, last update and activity status of searched series.
#'
#' @note The original language of the available series' names were preserved.
#'
#' @export
search_series <- function(terms = NULL, fields = c('name'), language = c("en", "br")) {
# Check language arg
language <- match.arg(language)
# Getting all series
all_series <- available_series(language = language)
# Searching
users_search <- dplyr::as_tibble(NULL)
if (!is.null(terms)) {
for (i in 1:length(fields)) {
for (j in 1:length(terms)) {
users_search %<>%
dplyr::bind_rows(users_search,
all_series %>%
dplyr::filter_(~ stringr::str_detect(string = get(fields[i]), pattern = terms[j]))) %>%
dplyr::distinct()
}
}
} else {
users_search <- all_series
}
# Setting labels in selected language
if (language == 'en') {
users_search %<>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Ipeadata Code','Serie Name (PT-BR)', 'Theme',
'Source', 'Frequency','Last Update','Status'))
} else {
users_search %<>%
purrr::set_names(c('code', 'name', 'theme', 'source',
'freq', 'lastupdate', 'status')) %>%
sjlabelled::set_label(c('Codigo Ipeadata','Nome da Serie', 'Nome da Base', 'Fonte',
'Frequencia','Ultima Atualizacao','Status'))
}
users_search
}
# Change frequency ------------------------------------------------
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.