fred_series {eFRED}

Fetch Data or Information on a SERIES in FRED

Description

Each of the functions accept a series ID from FRED and return a data.frame with information about the series.

Usage

fred_series(..., key = NULL, realtime_start = NULL, realtime_end = NULL)

fred_series_release(
  ...,
  key = NULL,
  realtime_start = NULL,
  realtime_end = NULL
)

fred_series_categories(
  ...,
  key = NULL,
  realtime_start = NULL,
  realtime_end = NULL
)

fred_series_tags(..., key = NULL, realtime_start = NULL, realtime_end = NULL)

fred_observations(
  ...,
  key = NULL,
  realtime_start = NULL,
  realtime_end = NULL,
  all = TRUE
)

fred_series_vintage(
  ...,
  key = NULL,
  realtime_start = NULL,
  realtime_end = NULL
)

Arguments

...

character vectors of series to fetch. If named, then the names are used to identify the series in the result.

key

32 character lower-cased alpha-numeric character string

realtime_start, realtime_end

character date strings of format "YYY-MM-DD" used obtain information that was known during the specified time period. If empty, the latest update of the information is used.

all

logical; should all observations be used? Defaults to TRUE. If FALSE, only observations existing in all series will be kept.

Details

Each function returns the following information in a data.frame.

fred_observations

Date of observation, its value, and the realtime start and end dates

fred_series

Series id, its title, observations start and end, frequency, units, seasonal adjustment type, popularity, realtime start and end, and when it was last updated

fred_series_categories

Category id, its name, and the id of its parent

fred_series_release

Release id, its name, a url link, whether there is a press release, and realtime start and end dates

fred_series_tags

Tag name, its group id, popularity, the number of series that are tagged, when it was created, and any notes about the tag

fred_series_related_tags

Same as fred_series_tags

fred_series_vintage

dates of each vintage

fred_category_related_tags

Same as fred_category_tags

Value

data.frame or list

Functions

• fred_series: get information about the series including observation periods, seasonal adjustment, units, title, etc.

• fred_series_release: get the release information about the series

• fred_series_categories: get the categories into which a series falls

• fred_series_tags: get the FRED tags for the series

• fred_observations: get the observational data for a series

• fred_series_vintage: get the dates in which the data for the series were revised or released. Returns a named list of dates.