ipeadatar (version 0.1.0)

metadata: 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)

Arguments

code

A character vector with Ipeadata code.

language

String specifying the selected language. Language options are English ("en", default) and Brazilian portuguese ("br").

quiet

Logical. If FALSE (default), a progress bar is shown.

Value

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.

References

This R package uses the Ipeadata API. For more information go to http://www.ipeadata.gov.br/.

See Also

available_series, available_subjects, available_territories

Examples

# NOT RUN {
# Metadata about
# "JPM366_EMBI366": J.P. Morgan Emerging Markets Bond Index (EMBI+), Brazil
# "SGS366_NASDAQ366": Nasdaq Composite Index - closed
meta <- metadata(code = c("JPM366_EMBI366", "SGS366_NASDAQ366"))

# Metadata about
# "PRECOS12_IPCA12": Extended National Consumer Price Index (IPCA), Brazil
# in Brazilian portuguese
metaBR <- metadata(code = "PRECOS12_IPCA12", language = "br")

# Regional metadata about
# "CONSUMOTOT": Electric energy consumption, Brazil
metaReg <- metadata(code = "CONSUMOTOT")

# }