metadata: Returns a metadata about the requested series

In ipeadatar: API Wrapper for 'Ipeadata'

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.

Note

The original language of the available series' names and the comments were preserved. The Ipeadata codes may be required by available_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 from
# "PRECOS12_IPCA12": Extended National Consumer Price Index (IPCA), Brazil
meta <- metadata(code = "PRECOS12_IPCA12")

## End(Not run)

ipeadatar documentation built on Feb. 3, 2022, 9:07 a.m.