Skip to contents

List relationships for a dataset

Source: R/package_relationships.R
package_relationships_list.Rd

List relationships for a dataset

Usage

package_relationships_list(
  id,
  id2 = NULL,
  relationship_type = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

id

(character or ckan_package) The dataset to inspect.

id2

(character or ckan_package) Optional secondary dataset identifier to scope results.

relationship_type

(character) Filter on relationship type (see package_relationship_create()).

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{
ckanr_setup(url = "https://demo.ckan.org/", key = "my-key")
package_relationships_list("my-dataset")
} # }