fredr_series: Return basic information for a FRED series.

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

Description

Given a series ID, return basic information for a FRED series. Note that this function will not return the actual series data. For this functionality, see fredr_series_observations().

Usage

fredr_series(series_id, ..., realtime_start = NULL, realtime_end = NULL)

Arguments

series_id	A string ID for the FRED series.
...	These dots only exist for future extensions and should be empty.
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 (1 row) with information for the series specified by series_id.

API Documentation

fred/series

See Also

fredr_series_observations(), fredr_series_search_text(), fredr_series_search_id(), fredr_series_search_tags(), fredr_series_search_related_tags(), fredr_series_categories(), fredr_series_release(), fredr_series_tags(), fredr_series_updates(), fredr_series_vintagedates().

Examples

if (fredr_has_key()) {
# Return information for the "UNRATE" series
fredr_series(series_id = "UNRATE")
}

Example output

fredr documentation built on Jan. 30, 2021, 1:06 a.m.