fredr_series_search_related_tags {fredr} | R Documentation |
Get the related FRED tags for one or more FRED tags matching a series search
Description
FRED tags are attributes assigned to series. Return the related FRED tags
for a search: tags assigned to series that match all tags in the tag_names
parameter (required), no tags in the exclude_tag_names
(optional) and the
search words set by the series_search_text
parameter (required).
Usage
fredr_series_search_related_tags(
series_search_text,
tag_names,
...,
exclude_tag_names = NULL,
tag_group_id = NULL,
tag_search_text = NULL,
limit = NULL,
offset = NULL,
order_by = NULL,
sort_order = NULL,
realtime_start = NULL,
realtime_end = NULL
)
Arguments
series_search_text |
A string containing the series search text. |
tag_names |
A semicolon delimited string of tag names to return. |
... |
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. Defaults to no tag filtering. |
tag_group_id |
A string indicating the tag group id to filter tags by type. Defaults to no filtering by tag group. Possible values are
|
tag_search_text |
A string to match tag names. Defaults to no filtering by tag name matching. |
limit |
An integer limit on the maximum number of results to return.
Defaults to |
offset |
An integer used in conjunction with |
order_by |
A string indicating the attribute to order results by.
Defaults to
|
sort_order |
A string representing the order of the resulting series.
Possible values are: |
realtime_start |
A |
realtime_end |
A |
Value
A tibble
object.
References
API Documentation:
See Also
fredr_series_observations()
, fredr_series_search_text()
,
fredr_series_search_id()
, fredr_series_search_tags()
,
fredr_series()
, fredr_series_categories()
,
fredr_series_release()
, fredr_series_tags()
, fredr_series_updates()
,
fredr_series_vintagedates()
.
Examples
if (fredr_has_key()) {
# Search for all tags matching the series text "oil" and the tag "usa".
fredr_series_search_related_tags(
series_search_text = "oil",
tag_names = "usa"
)
# Search for tags matching the series text "oil", the tag text "usa", and
# are related to the tag "usa". Return only results in the "src" (Source)
# group.
fredr_series_search_related_tags(
series_search_text = "oil",
tag_names = "usa",
tag_group_id = "src",
tag_search_text = "usa"
)
}