fredr_related_tags {fredr} | R Documentation |
Get related FRED tags given one or more tags
Description
Get related FRED tags. Optionally, filter results by tag group, or
search text. Related FRED tags are the tags assigned to series that match
all tags in the tag_names
parameter and no tags in the
exclude_tag_names
parameter.
Usage
fredr_related_tags(
tag_names,
...,
exclude_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
tag_names |
A semicolon delimited string of tag names to be related to. |
... |
These dots only exist for future extensions and should be empty. |
exclude_tag_names |
A semicolon delimited string of tag names that series match none of. No exclusions are done by default. |
tag_group_id |
A string tag group id to filter tags by type. No filtering by tag group by default. Possible values are:
|
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 |
offset |
An integer used in conjunction with |
order_by |
Order results by values of the specified attribute. Possible values are:
|
sort_order |
A string representing the order of the resulting series,
sorted by the attribute values specified by |
realtime_start |
A |
realtime_end |
A |
Value
A tibble
containing tags related to tag_names
and their
descriptions. Data include tag name, group ID, popularity, series count, tag
creation date, and additional notes.
API Documentation
See Also
fredr_category_tags()
, fredr_category_related_tags()
, fredr_docs()
,
fredr_release_tags()
, fredr_release_related_tags()
,
fredr_series_search_tags()
, fredr_series_search_related_tags()
,
fredr_tags_series()
, fredr_tags()
Examples
if (fredr_has_key()) {
fredr_related_tags(tag_names = "monetary aggregates;weekly")
fredr_related_tags(
tag_names = "monetary aggregates;weekly",
tag_group_id = "gen"
)
}