fredr: fredr_releases_dates – R documentation

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

fredr_releases_dates

Get release dates for all releases of economic data.

Description

Get release dates for all releases of economic data. Note that release dates are published by data sources and do not necessarily represent when data will be available on the FRED or ALFRED websites.

Usage

fredr_releases_dates(
  ...,
  limit = NULL,
  offset = NULL,
  sort_order = NULL,
  order_by = NULL,
  include_release_dates_with_no_data = NULL,
  realtime_start = NULL,
  realtime_end = NULL
)

Arguments

`...`	These dots only exist for future extensions and should be empty.
`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`.
`sort_order`	A string representing the order of the resulting series. Possible values are: `"asc"` and `"desc"` (default).
`order_by`	Order results by values of the specified attribute. Possible values include: `'release_date'` (default), `'release_id'`, `'release_name'`.
`include_release_dates_with_no_data`	A boolean value indicating if the results with no data available should be returned as well. Default is `FALSE`.
`realtime_start`	A `Date` indicating the start of the real-time period. Defaults to the first day of the current year. For more information, see Real-Time Periods.
`realtime_end`	A `Date` indicating the end of the real-time period. Defaults to `9999-12-31` (latest available). For more information, see Real-Time Periods.

Value

A tibble object.

API Documentation

fred/releases/dates

Examples

if (fredr_has_key()) {
fredr_releases_dates(limit = 20L)
}

fredr

An R Client for the 'FRED' API

v2.1.0

MIT + file LICENSE

Authors

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

Initial release