fred (version 0.3.1)

fred_all_vintages: Fetch every vintage of a series

Description

Returns the full revision history: one row per (observation date, realtime range) combination. This is the FRED API's output_type = 2 mode. The result can be reshaped into a vintage matrix or used to compute revision statistics.

Usage

fred_all_vintages(
  series_id,
  from = NULL,
  to = NULL,
  units = "lin",
  frequency = NULL,
  aggregation = "avg",
  cache = TRUE
)

Value

A fred_tbl with columns date, series_id, value, realtime_start, realtime_end. The realtime_start and realtime_end columns identify the vintage window for each row.

Arguments

series_id

Character. One or more FRED series IDs.

from, to

Optional observation date range.

units

Character. Raw FRED units code. Default "lin".

frequency, aggregation

Optional frequency aggregation arguments (see fred_series()).

cache

Logical. Cache results locally. Default TRUE.

Details

Be aware that some series have hundreds of thousands of vintage rows, so consider narrowing the date range with from/to for long-running indicators like GDP.

See Also

Other vintages: fred_as_of(), fred_first_release(), fred_real_time_panel()

Examples

# \donttest{
op <- options(fred.cache_dir = tempdir())
try({
  # All vintages of recent GDP releases
  gdp_vint <- fred_all_vintages("GDP", from = "2020-01-01")
})
options(op)
# }