fredr_release_dates {fredr}

Get release dates for a single release of economic data

Description

Get release dates for a single release of economic data

Usage

fredr_release_dates(
  release_id,
  ...,
  limit = NULL,
  offset = NULL,
  sort_order = NULL,
  include_release_dates_with_no_data = 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.

limit

An integer limit on the maximum number of results to return. Defaults to 10000, 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 release dates. Possible values are: "asc" (default), and "desc".

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 1776-07-04 (earliest available). 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/release/dates

See Also

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

Examples

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

# Call the function with an "as of" Date of 1997-03-14
fredr_release_dates(release_id = 20L, realtime_end = as.Date("1997-03-14"))
}