fredr_series_search_tags {fredr} | R Documentation |
Get the FRED tags for a series search.
Description
Return the FRED tags by searching for matches in series text.
Usage
fredr_series_search_tags(
series_search_text,
...,
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. |
... |
These dots only exist for future extensions and should be empty. |
tag_names |
A semicolon delimited string of tag names to return. Defaults no filtering by tag names. |
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 where each row represents a series tag matching the
query. Data include the tag name, group ID, tag creation date, popularity,
series count, and additional notes.
References
API Documentation:
See Also
fredr_series_search_text()
, fredr_series_search_id()
, fredr_series_search_related_tags()
, fredr_tags()
Examples
if (fredr_has_key()) {
# Search for tags matching the series text "gnp"
fredr_series_search_tags("gnp")
# Search for tags matching the series text "oil" and the tag text "usa"
fredr_series_search_tags(
series_search_text = "oil",
tag_search_text = "usa"
)
# Search for tags matching the series text "oil" and the tag text "usa".
# Return only results in the "geo" (Geography) group
fredr_series_search_tags(
series_search_text = "oil",
tag_group_id = "geo",
tag_search_text = "usa"
)
}