metadata: Metadata for Requested Series

In ipeadatar: API Wrapper for 'Ipeadata'

Metadata for Requested Series

Description

Returns metadata information for requested Ipeadata series.

Usage

metadata(code, language = c("en", "br"), label = TRUE, quiet = FALSE)

Arguments

code	A character vector of Ipeadata series codes.
language	A character string specifying the language. Available options are English ("en", default) and Brazilian Portuguese ("br").
label	Logical. If TRUE (default), variable labels are added to the output data frame using sjlabelled::set_label().
quiet	Logical. If FALSE (default), a progress bar is displayed.

Value

A data frame containing metadata for the requested Ipeadata series, including code, name, comments, last update, theme, source, frequency, unit, multiplier, status, subject code, and country code.

Note

The original language of series names and comments is preserved. Ipeadata codes may be obtained using available_series().

References

This package uses the Ipeadata API: https://www.ipeadata.gov.br/

See Also

available_series(), available_subjects(), available_territories()

Examples

meta <- metadata(code = "PRECOS12_IPCA12")

ipeadatar documentation built on May 28, 2026, 5:08 p.m.