fredr: fredr_series – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

fredr_series

Return basic information for a FRED series.

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

Examples

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

fredr

An R Client for the 'FRED' API

v2.1.0

MIT + file LICENSE

Authors

Sam Boysel [aut, cre], Davis Vaughan [aut]

Initial release