Package 'ipeadatar'

Title: API Wrapper for 'Ipeadata'
Description: Allows direct access to the macroeconomic, financial and regional database maintained by Brazilian Institute for Applied Economic Research ('Ipea'). This R package uses the 'Ipeadata' API. For more information, see <http://www.ipeadata.gov.br/>.
Authors: Luiz Eduardo S. Gomes [aut, cre], Jessyka A. P. Goltara [ctb]
Maintainer: Luiz Eduardo S. Gomes <[email protected]>
License: MIT + file LICENSE
Version: 0.1.6
Built: 2025-02-28 04:16:46 UTC
Source: https://github.com/gomesleduardo/ipeadatar

Help Index

List with available countries

Description

Returns a list with available countries from Ipeadata API database.

Usage

available_countries(language = c("en", "br"))

Arguments

language

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

Value

A data frame containing 3-letter country code and name of available countries.

List with available series

Description

Returns a list with available series from Ipeadata API database.

Usage

available_series(language = c("en", "br"))

Arguments

language

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

Value

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.

List with available subjects

Description

Returns a list with available subjects from Ipeadata API database.

Usage

available_subjects(language = c("en", "br"))

Arguments

language

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

Value

A data frame containing code and name of available subjects.

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"))

Arguments

language

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

Value

A data frame containing unit name, code, name and area (in km2) of Brazilian territorial divisions.

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)

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, date, value, territorial unit name and country or territorial code of requested series.

Note

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_territories

Examples

## Not run: 
# Data from
# "PAN_RRPE": Average real income from effective main work, Brazil
data <- ipeadata(code = "PAN_RRPE", language = "br")

## End(Not run)

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.

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)

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"))

Arguments

terms

A character vector with search terms.
fields

A character vector with table fields where matches are sought. See 'Details'.
language

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

Details

The fields options are "code", "name", "theme", "source", "freq", "lastupdate" and "status".

Value

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.