List groups.

List groups.

Usage

group_list(
  offset = 0,
  limit = 31,
  sort = NULL,
  groups = NULL,
  all_fields = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

offset

(numeric) Where to start getting activity items from (optional, default: 0)

limit

(numeric) The maximum number of activities to return (optional, default: 31)

sort

Field to sort on. You can specify ascending order, for example score desc. You can specify descending order, for example score asc. You can sort by two fields, for example score desc, price asc. You can sort by a function, for example sum(x_f, y_f) desc. The function then sorts by the sum of x_f and y_f in descending order.

groups

(character) A list of names of the groups to return. If you give this list, the function returns only groups with names in this list.

all_fields

(logical) Return full group dictionaries instead of names. Default: FALSE

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{
group_list(limit = 3)
group_list(limit = 3, as = "json")
group_list(limit = 3, as = "table")
} # }