Skip to content

ipea/ipeadatar

Repository files navigation

ipeadatar

CRAN status R-CMD-check CRAN downloads Lifecycle: experimental

ipeadatar is an R package that provides direct access to the macroeconomic, financial, social, and regional databases maintained by the Institute for Applied Economic Research (Ipea) through the Ipeadata API.

The package allows users to search for available series, retrieve metadata, and download time series directly from R.

Installation

The stable version can be installed from CRAN:

install.packages("ipeadatar")

The development version can be installed from GitHub:

# install.packages("pak")
pak::pak("ipea/ipeadatar")

Usage

Load the package:

library(ipeadatar)

Available series

Retrieve all available Ipeadata series:

series <- available_series()
head(series)

Search series

Search for series using keywords:

search_series("rural")

Metadata

Retrieve metadata for a specific series:

meta <- metadata("PRECOS12_IPCA12")
meta

Data

Retrieve observations for a specific series:

ipca <- ipeadata("PRECOS12_IPCA12")
head(ipca)

Basic plot

ipca <- ipeadata("PRECOS12_IPCA12")

plot(
  ipca$date,
  ipca$value,
  type = "l",
  xlab = "Date",
  ylab = "Value",
  main = "IPCA"
)

Main functions

Function Description
available_series() Lists available Ipeadata series
available_subjects() Lists available subjects
available_territories() Lists available territorial divisions
search_series() Searches for series using keywords
metadata() Retrieves metadata for requested series
ipeadata() Retrieves data for requested series

Variable labels

By default, functions add variable labels using sjlabelled.

available_series(label = TRUE)

To disable labels:

available_series(label = FALSE)

Documentation

Additional examples and package documentation are available in the package vignette:

browseVignettes("ipeadatar")

Note Ipea

ipeadatar is developed by researchers from the Institute for Applied Economic Research (Ipea).

About

An R package for Ipeadata API database

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages