fredr v1.0.0

0

Monthly downloads

0th

Percentile

An R Client for the 'FRED' API

An R client for the 'Federal Reserve Economic Data' ('FRED') API <https://api.stlouisfed.org>. Functions to retrieve economic time series and other data from 'FRED'.

Readme

fredr

Travis
branch AppVeyor Build Status Codecov GitHub
release GitHub
license

fredr provides a complete set of R bindings to the Federal Reserve Economic Data (FRED) RESTful API, provided by the Federal Reserve Bank of St. Louis. The functions allow the user to search for and fetch time series observations as well as associated metadata within the FRED database. The core functions are

  • fredr_set_key() - Set the required FRED API key for the session.
  • fredr() or fredr_series_observations() - Fetch a FRED series.
  • fredr_series_search_text() - Search for a FRED series by text.
  • fredr_request() - Send a general request to the FRED API.

Objects are returned as tibbles. The user is strongly encouraged to read the full FRED API documentation to leverage the full power of fredr and the FRED API.

Installation

install.packages("fredr")

To get the development version of the package:

# install.packages("devtools")
devtools::install_github("sboysel/fredr")

Usage

See the Get started article.

Documentation

See the documentation site.

See Also

There are several existing R packages designed for the FRED API:

Functions in fredr

Name Description
fredr_endpoints List of available FRED API endpoints.
fredr_release_tags Get the FRED tags for a release
fredr_series_search_related_tags Get the related FRED tags for one or more FRED tags matching a series search
fredr_series_search_tags Get the FRED tags for a series search.
fredr_releases Get all releases of economic data
fredr_series_vintagedates Get the data vintage dates for a FRED series
fredr_set_key Set the FRED API key
fredr_category_tags Get the FRED tags for a category
fredr_docs Open the web documentation for a certain FRED API topic.
fredr_category_children Get the child categories for a specified FRED parent category
fredr_category_related Get the related categories for a FRED category.
fredr_series_observations Get observations of a FRED series
fredr_releases_dates Get release dates for all releases of economic data.
fredr_category Get a FRED category
fredr_release Get a release of economic data
fredr_release_sources Get the sources for a release of economic data
fredr_release_dates Get release dates for a single release of economic data
fredr_series_updates Get a set of recently updated FRED series
fredr_series_tags Get the tags for a FRED series
fredr_category_related_tags Get the related FRED tags within a category
fredr_request Send a request to the FRED API
fredr_tags Get FRED series tags
fredr_release_tables Get release table trees for a given release
fredr_sources Get all sources of economic data
fredr_series_release Get the release for a FRED series
fredr_category_series Get the series in a category
fredr_series Return basic information for a FRED series.
fredr_series_categories Get the categories for a FRED series
fredr_series_search_text Search for a FRED series.
fredr_release_related_tags Get the related FRED tags for one or more FRED tags within a release
fredr_release_series Get the series on a release of economic data
fredr_tags_series Find FRED series matching tag names
fredr_source Get a source of economic data
fredr_source_releases Get the releases for a source
fredr_related_tags Get related FRED tags given one or more tags
No Results!

Vignettes of fredr

Name
fredr-categories.Rmd
fredr-releases.Rmd
fredr-series.Rmd
fredr-sources.Rmd
fredr-tags.Rmd
fredr.Rmd
No Results!

Last month downloads

Details

URL https://github.com/sboysel/fredr
BugReports https://github.com/sboysel/fredr/issues
License MIT + file LICENSE
LazyData true
RoxygenNote 6.0.1
VignetteBuilder knitr
NeedsCompilation no
Packaged 2018-07-23 01:57:40 UTC; sboysel
Repository CRAN
Date/Publication 2018-07-28 15:20:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/fredr)](http://www.rdocumentation.org/packages/fredr)