Skip to contents

Create a dataset relationship

Source: R/package_relationships.R
package_relationship_create.Rd

Create a dataset relationship

Usage

package_relationship_create(
  subject,
  object,
  relationship_type,
  comment = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

subject

(character or ckan_package) Dataset acting as the subject in the relationship.

object

(character or ckan_package) Dataset acting as the object in the relationship.

relationship_type

(character) Relationship type ("depends_on", "derives_from", etc.).

comment

(character) Optional note attached to the relationship.

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

if (FALSE) { # \dontrun{
package_relationship_create("dataset-a", "dataset-b", relationship_type = "derives_from")
} # }