related_create: Create a related item

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

Create a related item

Description

Create a related item

Usage

related_create(
  id,
  title,
  type,
  description = NULL,
  related_id = NULL,
  related_url = NULL,
  image_url = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

id	(character) id of package that the related item should be added to. This should be an alphanumeric string. Required.
title	(character) Title of the related item. Required.
type	(character) The type of the related item. One of API, application, idea, news article, paper, post or visualization. Required.
description	(character) description (optional). Optional
related_id	(character) An id to assign to the related item. If blank, an ID will be assigned for you. Optional
related_url	(character) A url to associated with the related item. Optional
image_url	(character) A url to associated image. Optional
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: 
# Setup
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

# create a package
(res <- package_create("hello-mars"))

# create a related item
related_create(res, title = "asdfdaf", type = "idea")

# pipe operations together
package_create("foobbbbbarrrr") %>%
   related_create(title = "my resource",
                  type = "visualization")

## End(Not run)

ckanr documentation built on March 31, 2023, 6:54 p.m.