Skip to contents

Create a tag

Source: R/tag_create.R
tag_create.Rd

You must be a sysadmin to create vocabulary tags.

Usage

tag_create(
  name,
  vocabulary_id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

name

(character) Name for the new tag. The name is a string between 2 and 100 characters long. The name contains only alphanumeric characters and -, _ and .. For example, 'Jazz'.

vocabulary_id

(character) ID of the vocabulary. You add the new tag to this vocabulary. For example, the ID of vocabulary 'Genre'.

url

Base URL to use. Default: https://demo.ckan.org/. 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 the table option uses jsonlite::fromJSON(..., simplifyDataFrame = TRUE), which attempts to parse data to data.frame's when possible. The result can vary from a vector, list or data.frame. (required)

...

Extra curl arguments. The function passes them to verb-POST (optional)

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

if (FALSE) { # \dontrun{
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = Sys.getenv("CKAN_DEMO_KEY")
)
tag_create(name = "TestTag1", vocabulary_id = "Testing1")
} # }