fredr_releases: Get all releases of economic data

Description Usage Arguments Value API Documentation See Also Examples

View source: R/fredr_releases.R

Description

Get all releases of economic data

Usage

1
2
3
4
5
6
7
8
9
fredr_releases(
  ...,
  limit = NULL,
  offset = NULL,
  order_by = NULL,
  sort_order = 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.

order_by

Order results by values of the specified attribute. Possible values include: 'release_id' (default), 'name', 'press_release', 'realtime_start', 'realtime_end'.

sort_order

A string representing the order of the resulting series. Possible values are: "asc" (default), and "desc".

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.

API Documentation

fred/releases

See Also

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

Examples

1
2
3
if (fredr_has_key()) {
fredr_releases(limit = 20L)
}

Example output



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