fredr_series_tags: Get the tags for a FRED series

Description Usage Arguments Value API Documentation See Also Examples

View source: R/fredr_series_tags.R

Description

Given a series ID, return associated tags for the series as a tibble object.

Usage

1
2
3
4
5
6
7
8
fredr_series_tags(
  series_id,
  ...,
  order_by = NULL,
  sort_order = NULL,
  realtime_start = NULL,
  realtime_end = NULL
)

Arguments

series_id

A string ID for the FRED series.

...

These dots only exist for future extensions and should be empty.

order_by

A string indicating the attribute by which to order the Possible values include "series_count" (default), "popularity", "created", "name", and "group_id".

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 where each row is represents a tag associated with the series specified by series_id'. Data include tag name, group ID, popularity, series count, tag creation date, and additional notes.

API Documentation

fred/series/tags

See Also

fredr_series_observations(), fredr_series_search_text(), fredr_series_search_id(), fredr_series_search_tags(), fredr_series_search_related_tags(), fredr_series(), fredr_series_categories(), fredr_series_release(), fredr_series_updates(), fredr_series_vintagedates().

Examples

1
2
3
4
5
if (fredr_has_key()) {
# Return all tags assigned to the "UNRATE" series and order the results by
# group ID.
fredr_series_tags(series_id = "UNRATE", order_by = "group_id")
}

Example output



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