regexSeriesLabel: Searches for matches in series' labels

In valetr: Interface to Bank of Canada's 'Valet' API

Description

Exploratory function. If the pattern successfuly matches one or more series labels, then a data.frame is returned with the series label and link. The link can be used in the function getSeriesData to fetch the data.

Usage

regexSeriesLabel(pattern = NULL, ...)

Arguments

pattern	character string as regular expression. Only accepts character string. If length is greater than 1, the first element is used. Defaults to NULL. The default option returns a data.frame with all series with labels and links in the API.
...	accepts the follwing extra arguments from grep: ignore.case, perl, fixed and useBytes.

Value

A data.frame. Columns are the series label, link and name respectively.

See Also

getSeriesInfo, grep

Examples

# get a list of series that matches the pattern "CPI"


#'
cpiList <- regexSeriesLabel(pattern="cpi") # no match, returns an empty data.frame
cpiList2 <- regexSeriesLabel(pattern="cpi", ignore.case=TRUE) # finds match

valetr documentation built on Aug. 9, 2019, 5:06 p.m.