fredr_release_series: Get the series on a release of economic data

In sboysel/fredr: An R Client for the 'FRED' API

Description

Get the series on a release of economic data

Usage

fredr_release_series(
  release_id,
  ...,
  filter_variable = NULL,
  filter_value = NULL,
  tag_names = NULL,
  exclude_tag_names = NULL,
  limit = NULL,
  offset = NULL,
  order_by = NULL,
  sort_order = NULL,
  realtime_start = NULL,
  realtime_end = NULL
)

Arguments

release_id	An integer ID of the release.
...	These dots only exist for future extensions and should be empty.
filter_variable	A string indicating which attribute to indicate the attribute that results are filtered by. Possible values include: "frequency", "units", "seasonal_adjustment". No filtering by default.
filter_value	A string giving the value of the filter_variable attribute to filter results by. filter_variable must be set. No filtering by default.
tag_names	A string indicating which series tags to match. Multiple tags can be delimited by a semicolon in a single string (e.g. '"usa;gnp"“).
exclude_tag_names	A string indicating which series tags should not be matched. Multiple tags can be delimited by a semicolon in a single string (e.g. '"usa;gnp"“).
limit	An integer limit on the maximum number of results to return. Defaults to 1000, the maximum.
offset	An integer used in conjunction with limit for long series. This mimics the idea of pagination to retrieve large amounts of data over multiple calls. Defaults to 0.
order_by	A string indicating an attribute by which the results are ordered by. Possible values include: "series_id" (default) "title" "units" "frequency" "seasonal_adjustment" "realtime_start" "realtime_end" "last_updated" "observation_start" "observation_end" "popularity" "group_popularity"
sort_order	A string representing the order of the resulting series. Possible values are: "asc" (default), and "desc".
realtime_start	A Date indicating the start of the real-time period. Defaults to today's date. For more information, see Real-Time Periods.
realtime_end	A Date indicating the end of the real-time period. Defaults to today's date. For more information, see Real-Time Periods.

Value

A tibble object.

API Documentation

fred/release/series

See Also

fredr_releases(), fredr_releases_dates(), fredr_release(), fredr_release_dates(), fredr_release_sources(), fredr_release_tags(), fredr_release_related_tags(), fredr_release_tables()

Examples

if (fredr_has_key()) {
fredr_release_series(release_id = 20L)

fredr_release_series(release_id = 20L, order_by = "popularity")

# Extract the "catalog" of series from a release on a certain date
fredr_release_series(
   release_id = 20L,
   realtime_end = as.Date("2018-07-13"),
   order_by = "popularity"
)
}

sboysel/fredr documentation built on Aug. 15, 2021, 9:19 a.m.