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.
fredr_related_tags(tag_names = NULL, 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)
A semicolon delimited string of tag names to be related to. Required parameter.
A semicolon delimited string of tag names that series match none of. No exclusions are done by default.
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
A string indicating the words to find matching tags with. No filtering by search words by default.
An integer limit on the maximum number of results to return.
Defaults to 1000
, the maximum.
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 results by values of the specified attribute. Possible values are:
"series_count"
(default)
"popularity"
"created"
"name"
"group_id"
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"
.
A Date
indicating the start of the real-time period.
Defaults to today's date. For more information, see
Real-Time Periods.
A Date
indicating the end of the real-time period.
Defaults to today's date. For more information, see
Real-Time Periods.
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.
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()
# NOT RUN {
# }
# NOT RUN {
fredr_related_tags(tag_names = "monetary aggregates;weekly")
fredr_related_tags(
tag_names = "monetary aggregates;weekly",
tag_group_id = "gen"
)
# }
Run the code above in your browser using DataCamp Workspace