fredr_category_tags {fredr} | R Documentation |
Get the FRED tags for a category
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
fredr_category_tags(
category_id,
...,
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. |
... |
These dots only exist for future extensions and should be empty. |
tag_names |
A string indicating which series tags to match. Multiple
tags can be delimited by a semicolon in a single string (e.g. |
tag_group_id |
A string representing the tag group id to filter tags by type. No filtering by default. Possible values include:
|
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 |
offset |
An non-negative integer used in conjunction with |
order_by |
Order results by values of the specified attribute.
Possible values include: |
sort_order |
A string representing the order of the resulting series.
Possible values are: |
realtime_start |
A |
realtime_end |
A |
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
See Also
fredr_category()
, fredr_category_children()
, fredr_category_related()
,
fredr_category_series()
, fredr_category_related_tags()
Examples
if (fredr_has_key()) {
# 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")
}