tag_search: Search tags.

In ropensci/ckanr: Client for the Comprehensive Knowledge Archive Network ('CKAN') API

Search tags.

Description

Search tags.

Usage

tag_search(
  query = NULL,
  vocabulary_id = NULL,
  offset = 0,
  limit = 31,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

query	(character) A tag name query to search for, if given only tags whose names contain this string will be returned; one or more search strings
vocabulary_id	(character) The id or name of a vocabulary, if give only tags that belong to this vocabulary will be returned
offset	(numeric) Where to start getting activity items from (optional, default: 0)
limit	(numeric) The maximum number of activities to return (optional, default: 31)
url	Base url to use. Default: https://data.ontario.ca/ See also ckanr_setup and get_default_url.
key	A privileged CKAN API key, Default: your key set with ckanr_setup
as	(character) One of list (default), table, or json. Parsing with table option uses jsonlite::fromJSON(..., simplifyDataFrame = TRUE), which attempts to parse data to data.frame's when possible, so the result can vary from a vector, list or data.frame. (required)
...	Curl args passed on to verb-POST (optional)

Examples

## Not run: 
tag_search(query = 'ta')
tag_search(query = c('ta', 'al'))

# different formats back
tag_search(query = 'ta', as = 'json')
tag_search(query = 'ta', as = 'table')

## End(Not run)

ropensci/ckanr documentation built on March 25, 2023, 12:01 p.m.