fredr (version 1.0.0)

fredr_release_tags: Get the FRED tags for a release

Description

Get the FRED tags for a release. Optionally, filter results by tag name, tag group, or search text.

Usage

fredr_release_tags(release_id = NULL, tag_names = NULL,
  tag_group_id = NULL, search_text = NULL, limit = NULL, offset = NULL,
  order_by = NULL, sort_order = NULL, realtime_start = NULL,
  realtime_end = NULL)

Arguments

release_id

An integer ID of the release. Required parameter.

tag_names

A semicolon delimited string of tag names to only include in the response. No filtering by tag names by default (i.e. all FRED tags returned).

tag_group_id

A string tag group id to filter tags by type. No filtering by tag group by default. Possible values are:

• "freq" = Frequency

• "gen" = General or Concept

• "geo" = Geography

• "geot" = Geography Type

• "rls" = Release

• "seas" = Seasonal Adjustment

• "src" = Source

search_text

A string indicating the words to find matching tags with. No filtering by search words by default.

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 are:

• "series_count" (default)

• "popularity"

• "created"

• "name"

• "group_id"

sort_order

A string representing the order of the resulting series, sorted by the attribute values specified by order_by. 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/release/tags

See Also

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

Examples

# NOT RUN {
fredr_release_tags(release_id = 10L)
# }