group_show: Show a package

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

Show a package

Description

Show a package

Usage

group_show(
  id,
  include_datasets = TRUE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

id	(character) Package identifier.
include_datasets	(logical) Include a list of the group's datasets. Default: TRUE
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)

Details

By default the help and success slots are dropped, and only the result slot is returned. You can request raw json with as = 'json' then parse yourself to get the help slot.

Examples

## Not run: 
res <- group_list()

# via a group name/id
group_show(res[[1]]$name)

# or via an object of class ckan_group
group_show(res[[1]])

# return different data formats
group_show(res[[1]]$name, as = 'json')
group_show(res[[1]]$name, as = 'table')

## End(Not run)

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