cso_search_toc: Search list of all table descriptions for given string

View source: R/cso_get_toc.R

cso_search_tocR Documentation

Search list of all table descriptions for given string

Description

Searches the list of all table descriptions returned by cso_get_toc() for a given substring.

Usage

cso_search_toc(
  string,
  toc = cso_get_toc(suppress_messages = TRUE, flush_cache = FALSE, from_date = NULL)
)

Arguments

string

string. The text to search for. Case insensitive.

toc

data.frame. The table of contents as returned by cso_get_toc. If not given, will be re-downloaded (or retrieved from cache) using cso_get_toc().

flush_cache

logical. If TRUE the cache will be checked for old, unused files. Any files wich have not been accessed in the last month will be deleted strings.

Value

data frame of three character columns, with layout identical to that of cso_get_toc. A subset of the results of cso_get_toc, with only rows where the description field contains the entered string.

Examples

## Not run: 
trv <- cso_search_toc("travel")

## End(Not run)

csodata documentation built on Aug. 11, 2023, 5:08 p.m.