fredr_category_tags: Get the FRED tags for a category

Description Usage Arguments Value API Documentation See Also Examples

View source: R/fredr_category_tags.R

Description

Get the FRED tags for a category. Optionally, filter results by tag name, tag group, or search. Series are assigned tags and categories. Alternatively, it is possible to get the tags for a category through a call to a function in the fredr/series endpoint. See fredr_series. No tags exist for a category that does not have series.

Usage

1
2
3
4
fredr_category_tags(category_id = 0L, 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

category_id

An integer ID for the category. Default is 0 for the root category. Required parameter.

tag_names

A string indicating which series tags to match. Multiple tags can be delimited by a semicolon in a single string (e.g. '"usa;gnp"“).

tag_group_id

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

  • "freq" - Frequency

  • "gen" - General or Concept

  • "geo" - Geography

  • "geot" - Geography Type

  • "rls" - Release

  • "seas" - Seasonal Adjustment

  • "src" - Source

search_text

A string to match text of tags. No matching by default.

limit

An positive integer indicating maximum number of results to return. Possible values are any integer between 1 and 1000 (default), inclusive.

offset

An non-negative 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: "series_count" (default), "popularity"``,"created","name","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 information on tags matching the request and their descriptions. Data include tag name, group ID, popularity, series count, tag creation date, and additional notes.

API Documentation

fred/category/tags

See Also

fredr_category(), fredr_category_children(), fredr_category_related(), fredr_category_series(), fredr_category_related_tags()

Examples

1
2
3
4
# Tags assigned to series in the "Production & Business Activity" category
fredr_category_tags(category = 1L)
# Select the "nation" and "monthly" tags in the "Production & Business Activity" category
fredr_category_tags(category = 3L, tag_names = "nation;monthly", order_by = "popularity")

fredr documentation built on May 2, 2019, 7:29 a.m.