Skip to contents

List organizations

Source: R/organization_list.R
organization_list.Rd

List organizations

Usage

organization_list(
  order_by = c("name", "package"),
  decreasing = FALSE,
  organizations = NULL,
  all_fields = TRUE,
  limit = 31,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

order_by

(character, only the first element is used). The field to sort the list by, must be name or packages.

decreasing

(logical). It shows if the sort order decreases.

organizations

(character or NULL). A list of names of the organizations to return. NULL returns all organizations.

all_fields

(logical). Return the name or all fields of the object.

limit

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

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{
ckanr_setup(url = "https://demo.ckan.org/")

# list organizations
res <- organization_list()
res[1:2]

# Different data formats
organization_list(as = "json")
organization_list(as = "table")
} # }