Description Usage Arguments Details Value See Also Examples
View source: R/getSeriesInfo.R
Exploratory function (albeit more complete than regexSeriesLabel
). The pattern arguments searches for information on
series based on their group label and series label. A data.frame
is returned with the series' group name, group label, group
description, series label, series link and series name. This function utilizes the "Series Group" route in the Valet API and provides
the full set of information available to a series. The series' link (or name) can be used in the function getSeriesData
to fecth data.
1 | getSeriesInfo(patternGroupLabel = NULL, patternSeriesLabel = NULL, ...)
|
patternGroupLabel |
character string as regular expression. Only accepts character string or |
patternSeriesLabel |
character string as regular expression. Only accepts character string or |
... |
accepts the follwing extra arguments from |
The data.frame
returned from this function contains all information available in the
Series Group router in the Valet API. This function is more complete than
regexSeriesLabel
. getSeriesInfo
returns not only the series label and link (also available in regexSeriesLabel
) but
also a series' group name, group label, group description and series name.
If patternGroupLabel
is NULL
, then the function will retrieve information for all groups (and their associated series).
This results in a longer processing time. A progress bar tracks the retrieval process.
An n x 6 data.frame
with columns representing the different characteristic of a series.
1 2 3 4 5 | # returns series info
seriesInfo <- getSeriesInfo(patternGroupLabel="(?i)consumer price",
patternSeriesLabel="(?i)seasonally")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.