Package 'ckanr'

Description

ckanr is a client for the CKAN API. It wraps all APIs for reading and writing data. If you have problems, or have use cases that the package does not cover yet, get in touch (https://github.com/ropensci/ckanr/issues)

CKAN API

Documentation for the CKAN API is at https://docs.ckan.org/en/2.12/api/index.html. The package follows the latest version of the API.

ckanr package API

The functions can be grouped into those for setup, packages, resources, tags, organizations, groups, and users.

• Setup - The main one is ckanr_setup() - and many related functions, e.g., get_default_key()

• Packages - Create a package with package_create(), and see other functions starting with ⁠package_*⁠

• Resources - Create a package with resource_create(), and see other functions starting with ⁠resource_*⁠

• Tags - List tags with tag_list(), and see other functions starting with ⁠tag_*⁠

• Organizations - List organizations with organization_list(), show a specific organization with organization_show(), and create with organization_create()

• Groups - List groups with group_list(), and see other functions starting with ⁠group_*⁠

• Users - List users with user_list(), and see other functions starting with ⁠user_*⁠

• Related items - See functions starting with ⁠related_*⁠

Datastore

The package supports the Datastore extension (https://docs.ckan.org/en/2.12/maintaining/datastore.html). It provides these functions:

• ds_create()

• ds_create_dataset()

• ds_search()

• ds_search_sql()

Fetch

Data comes back in a wide range of formats. The package provides a function to help you fetch metadata. The function also fetches the actual data for a link to a file on a CKAN instance. If you know what you are doing, you can use your preferred tool for the job. For example, you like read.csv() for reading csv files.

CKAN Instances

A helper function (servers()) lists the current CKAN instances that the package knows about. It gives the base URLs that work with this package. The URLs are not necessarily landing pages of each instance, but the URL can be the landing page and the base API URL.

Author(s)

Scott Chamberlain [email protected]

Florian Mayer [email protected]

Wush Wu

Imanuel Costigan [email protected]

Sharla Gelfand

Francisco Alves [email protected]

See Also

Useful links:

• https://docs.ropensci.org/ckanr/ (website) https://github.com/ropensci/ckanr (devel)

• Report bugs at https://github.com/ropensci/ckanr/issues

Description

These helpers wrap CKAN's ckanext.activity endpoints. The target CKAN instance must enable the activity core plugin.

Usage

group_activity_list(
  id,
  offset = 0,
  limit = 31,
  include_hidden_activity = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

organization_activity_list(
  id,
  offset = 0,
  limit = 31,
  include_hidden_activity = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

recently_changed_packages_activity_list(
  offset = 0,
  limit = 31,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

dashboard_new_activities_count(
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

dashboard_mark_activities_old(
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

activity_show(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

activity_data_show(
  id,
  object_type,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

activity_diff(
  id,
  object_type,
  diff_type = "unified",
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

activity_create(
  user_id,
  object_id,
  activity_type,
  data = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

send_email_notifications(
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
activity_show(id = "my-activity-id")
group_activity_list(id = "my-group")

## End(Not run)

Description

These helpers wrap the CKAN 2.12 activity purge feature (https://github.com/ckan/ckan/pull/8189). You must have sysadmin rights and the target instance must enable the activity plugin with CKAN 2.12 or later. Each wrapper calls ensure_action_available() so it fails clearly on older instances.

Usage

activity_delete(
  id = NULL,
  start_date = NULL,
  end_date = NULL,
  offset_days = NULL,
  keep = NULL,
  batch_size = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

activity_delete_all(
  batch_size = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

activity_delete_counts(
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
activity_delete_counts()
activity_delete(offset_days = 365)

## End(Not run)

Description

Inspect, create, and revoke API tokens for a user.

Usage

api_token_list(
  user_id = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

api_token_create(
  user,
  name,
  extra_fields = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

api_token_revoke(
  token = NULL,
  jti = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-ckan-key")
api_token_list(user_id = "my-user-id")

## End(Not run)

Description

ckan_file class helpers

Usage

as.ckan_file(x, ...)

is.ckan_file(x)

Arguments

Value

A ckan_file object, a list with S3 class ckan_file.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

# create item class from only an item ID
as.ckan_file("file-id-here")

# gives back itself
(x <- as.ckan_file(list(id = "file-id-here", name = "file.txt")))
as.ckan_file(x)

## End(Not run)

Description

ckan_group class helpers

Usage

as.ckan_group(x, ...)

is.ckan_group(x)

Arguments

Value

A ckan_group object, a list with S3 class ckan_group.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

(grps <- group_list())
grps[[3]]

# create item class from only an item ID
as.ckan_group(grps[[3]]$id)

# gives back itself
(x <- as.ckan_group(grps[[3]]$id))
as.ckan_group(x)

## End(Not run)

Description

ckan_organization class helpers

Usage

as.ckan_organization(x, ...)

is.ckan_organization(x)

Arguments

Value

A ckan_organization object, a list with S3 class ckan_organization.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

(orgs <- organization_list(limit = 3))
orgs[[3]]

# create item class from only an item ID
as.ckan_organization(orgs[[3]]$id)

# gives back itself
(x <- as.ckan_organization(orgs[[3]]$id))
as.ckan_organization(x)

## End(Not run)

Description

ckan_package class helpers

Usage

as.ckan_package(x, ...)

is.ckan_package(x)

Arguments

Value

A ckan_package object, a list with S3 class ckan_package.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

(pkgs <- package_search())
pkgs$results
pkgs$results[[3]]

# create item class from only an item ID
as.ckan_package(pkgs$results[[3]]$id)

# gives back itself
(x <- as.ckan_package(pkgs$results[[3]]$id))
as.ckan_package(x)

## End(Not run)

Description

ckan_related class helpers

Usage

as.ckan_related(x, ...)

is.ckan_related(x)

Arguments

Value

A ckan_related object, a list with S3 class ckan_related.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

(x <- package_create("foobbbbbarrrrr") |>
  related_create(
    title = "my resource",
    type = "visualization"
  ))

# create item class from only an item ID
as.ckan_related(x$id)

# gives back itself
(x <- as.ckan_related(x$id))
as.ckan_related(x)

## End(Not run)

Description

ckan_resource class helpers

Usage

as.ckan_resource(x, ...)

is.ckan_resource(x)

Arguments

Value

A ckan_resource object, a list with S3 class ckan_resource.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

(resrcs <- resource_search(q = "name:data"))
resrcs$results
resrcs$results[[3]]

# create item class from only an item ID
as.ckan_resource(resrcs$results[[3]]$id)

# gives back itself
(x <- as.ckan_resource(resrcs$results[[3]]$id))
as.ckan_resource(x)

## End(Not run)

Description

ckan_resource_view class helpers

Usage

as.ckan_resource_view(x, ...)

is.ckan_resource_view(x)

Arguments

Value

A ckan_resource_view object, a list with S3 class ckan_resource_view.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = Sys.getenv("CKAN_DEMO_KEY")
)

res <- package_show("sample-dataset")
views <- resource_view_list(res$resources[[1]]$id)

# Coerce from ID
as.ckan_resource_view(views[[1]]$id)

# Pass through existing objects
as.ckan_resource_view(views[[1]])

## End(Not run)

Description

ckan_tag class helpers

Usage

as.ckan_tag(x, ...)

is.ckan_tag(x)

Arguments

Value

A ckan_tag object, a list with S3 class ckan_tag.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

(tags <- tag_search(query = "ta"))
tags[[3]]

# create item class from only an item ID
as.ckan_tag(tags[[3]]$id)

# gives back itself
(x <- as.ckan_tag(tags[[3]]$id))
as.ckan_tag(x)

## End(Not run)

Description

ckan_user class helpers

Usage

as.ckan_user(x, ...)

is.ckan_user(x)

Arguments

Value

A ckan_user object, a list with S3 class ckan_user.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

(usrs <- user_list())
usrs[1:3]
usrs[[3]]

# create item class from only an item ID
as.ckan_user(usrs[[3]]$id)

# gives back itself
(x <- as.ckan_user(usrs[[3]]$id))
as.ckan_user(x)

## End(Not run)

Description

ckan_vocabulary class helpers

Usage

as.ckan_vocabulary(x, ...)

is.ckan_vocabulary(x)

Arguments

Value

A ckan_vocabulary object, a list with S3 class ckan_vocabulary.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

vocab <- vocabulary_create(name = sprintf("demo_vocab_%s", sample.int(1e4, 1)))

# create class from an id
as.ckan_vocabulary(vocab$id)

# passing through existing objects is a no-op
as.ckan_vocabulary(vocab)

## End(Not run)

Description

Make a list of datasets private, public, or deleted in a single call. You must be authorized to edit the datasets (for example, an editor or admin of the owning organization). See the official API contracts: https://docs.ckan.org/en/2.11/api/#ckan.logic.action.update.bulk_update_private, https://docs.ckan.org/en/2.11/api/#ckan.logic.action.update.bulk_update_public, https://docs.ckan.org/en/2.11/api/#ckan.logic.action.update.bulk_update_delete.

Usage

bulk_update_private(
  datasets,
  org_id,
  url = get_default_url(),
  key = get_default_key(),
  ...
)

bulk_update_public(
  datasets,
  org_id,
  url = get_default_url(),
  key = get_default_key(),
  ...
)

bulk_update_delete(
  datasets,
  org_id,
  url = get_default_url(),
  key = get_default_key(),
  ...
)

Arguments

Value

(logical) TRUE when CKAN applies the bulk update successfully.

References

https://docs.ckan.org/en/2.11/api/#ckan.logic.action.update.bulk_update_private

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

org <- organization_create("bulk-org")
ds1 <- package_create("bulk-dataset-1", owner_org = org$id)
ds2 <- package_create("bulk-dataset-2", owner_org = org$id)

bulk_update_private(c(ds1$id, ds2$id), org_id = org$id)
bulk_update_public(c(ds1$id, ds2$id), org_id = org$id)
bulk_update_delete(c(ds1$id, ds2$id), org_id = org$id)

## End(Not run)

Description

Get an activity stream of recently changed datasets on a site.

Usage

changes(
  offset = 0,
  limit = 31,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
changes()
changes(as = "json")
changes(as = "table")

## End(Not run)

Description

You must set the CKAN action and the HTTP verb. You also set query parameters, body data, and headers.

Usage

ckan_action(
  action,
  query = NULL,
  body = NULL,
  headers = list(),
  verb = "POST",
  url = get_default_url(),
  key = get_default_key(),
  ...
)

Arguments

Value

A text string. The function returns text because the data type is unknown ahead of time. You parse the text as needed.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

ckan_action("package_list")
ckan_action("package_list", verb = "GET")
ckan_action("package_list", url = "https://data.nhm.ac.uk")

## End(Not run)

Description

ckanr S3 classes

The classes

• ckan_package - CKAN package

• ckan_resource - CKAN resource

• ckan_resource_view - CKAN resource view

• ckan_related - CKAN related item

• ckan_file - CKAN file (first-class file entities, CKAN 2.12+)

Coercion

The ⁠as.ckan_*()⁠ functions for each CKAN object type coerce an object to an S3 class of that type. For example, you can coerce a package ID as a character string into an ckan_package object by calling ⁠as.ckan_package(<id>⁠.

Testing for classes

To test the class of an object, use an ⁠is._ckan_*()⁠ function for the classes listed above. The function returns TRUE or FALSE.

Manipulation

These are S3 classes. Each class is an R list with an attached class. The class tells functions what to do with the object. Functions accept flexible inputs and return flexible outputs. You can edit one of these classes yourself by changing values in the list.

See Also

as.ckan_package(), as.ckan_resource(), as.ckan_resource_view(), as.ckan_related(), as.ckan_file()

Description

Download a file

Usage

ckan_fetch(
  x,
  store = "session",
  path = "file",
  format = NULL,
  key = get_default_key(),
  ...
)

Arguments

Details

You can pass additional arguments with ... to the function that reads the file. The function uses ... only when store="session" and the file is not a ZIP file.

This list shows the function that reads each file format. You can see what additional arguments are available:

• csv: read.csv

• xls, xlsx: read_excel

• xml: read_xml

• html: read_html

• json: fromJSON

• shp, geojson: st_read

• txt: read.table

• parquet: read_parquet

Value

With store = "session" (default), the file contents, usually a data.frame (Excel files with multiple sheets and ZIP files return a named list). With store = "disk", a list with download details including the file path.

Examples

## Not run: 
# CSV file
ckanr_setup("https://datamx.io")
res <- resource_show(
  id = "6145a539-cbde-4b0d-a3d3-d1a5eb013f5c",
  as = "table"
)
head(ckan_fetch(res$url))
ckan_fetch(res$url, "disk", "myfile.csv")

# CSV file, format not available
ckanr_setup("https://ckan0.cf.opendata.inter.prod-toronto.ca")
res <- resource_show(
  id = "c57c3e1c-20e2-470f-bc82-e39a0264be31",
  as = "table"
)
res$url
res$format
head(ckan_fetch(res$url, format = res$format))

# Excel file - requires readxl package
ckanr_setup("https://datamx.io")
res <- resource_show(
  id = "e883510e-a082-435c-872a-c5b915857ae1",
  as = "table"
)
head(ckan_fetch(res$url))

# Excel file, multiple sheets - requires readxl package
ckanr_setup()
res <- resource_show(
  id = "ce02a1cf-35f1-41df-91d9-11ed1fdd4186",
  as = "table"
)
x <- ckan_fetch(res$url)
names(x)
head(x[["Mayor - Maire"]])

# XML file - requires xml2 package
ckanr_setup("https://data.ottawa.ca")
res <- resource_show(id = "380061c1-6c46-4da6-a01b-7ab0f49a881e",
as = "table")
ckan_fetch(res$url)

# HTML file - requires xml2 package
ckanr_setup("https://open.canada.ca/data/en")
res <- resource_show(
  id = "80321bac-4283-487c-93bd-c65acaa660f5",
  as = "table"
)
ckan_fetch(res$url)
library("xml2")
xml_text(xml_find_first(xml_children(ckan_fetch(res$url))[[1]], "title"))

# JSON file, by default reads in to a data.frame for ease of use
ckanr_setup("https://data.surrey.ca")
res <- resource_show(
  id = "8d07c662-800d-4977-9e3e-5a3d2d1e99ab",
  as = "table"
)
head(ckan_fetch(res$url))

# SHP file (spatial data, ESRI format) - requires sf package
ckanr_setup("https://ckan0.cf.opendata.inter.prod-toronto.ca")
res <- resource_show(
  id = "27362290-8bbf-434b-a9de-325a6c2ef923",
  as = "table"
)
x <- ckan_fetch(res$url)
class(x)
plot(x[, c("AREA_NAME", "geometry")])

# GeoJSON file - requires sf package
ckanr_setup("https://datamx.io")
res <- resource_show(
  id = "b1cd35b7-479e-4fa0-86e9-e897d3c617e6",
  as = "table"
)
x <- ckan_fetch(res$url)
class(x)
plot(x[, c("mun_name", "geometry")])

# ZIP file - packages required depends on contents
ckanr_setup("https://ckan0.cf.opendata.inter.prod-toronto.ca")
res <- resource_show(
  id = "bb21e1b8-a466-41c6-8bc3-3c362cb1ed55",
  as = "table"
)
x <- ckan_fetch(res$url)
names(x)
head(x[["ChickenpoxAgegroups2017.csv"]])

# TXT file
ckanr_setup("https://ckan0.cf.opendata.inter.prod-toronto.ca")
res <- resource_show(
  id = "e4211f49-611f-438c-a444-aaa7f3f84117",
  as = "table"
)
x <- ckan_fetch(res$url)
head(x)

# TXT file, semicolon used as separator
ckanr_setup("https://data.coat.no")
res <- resource_show(
  id = "384fe537-e0bd-4e57-8a0d-420b7a745196",
  as = "table"
)
x <- ckan_fetch(res$url, sep = ";")
head(x)

# Parquet file - requires arrow package
ckanr_setup("https://data.coat.no")
res <- resource_show(
  id = "b7d1c192-0f44-4bab-bd51-eea0d408a09f",
  as = "table"
)
x <- ckan_fetch(res$url)
head(x)

## End(Not run)

Description

Get information on a CKAN server

Usage

ckan_info(url = get_default_url(), ...)

ckan_version(url = get_default_url(), ...)

Arguments

Value

For ckan_info, the function returns a list with many slots with various info. For ckan_version, the function returns a list of length two, with the actual version as character. The second item converts the version to numeric (any dots or letters removed)

Examples

## Not run: 
ckan_info()
ckan_info(servers()[5])

ckan_version(servers()[5])

## End(Not run)

Description

Get or set ckanr CKAN settings

Usage

ckanr_settings()

get_default_url()

get_default_key()

get_test_url()

get_test_key()

get_test_did()

get_test_rid()

get_test_gid()

get_test_oid()

get_test_behaviour()

Value

ckanr_settings prints your base url, API key (if used), and optional test server settings (URL, API key, a dataset ID and a resource ID). ckanr_setup sets your production and test settings. ⁠get_test_*⁠ gets each of those settings. test_behaviour states whether the CKANR test suite skips ("SKIP") or fails ("FAIL") writing tests when the configured test CKAN settings do not work.

See Also

ckanr_setup(), get_default_url(), get_default_key(), get_test_url(), get_test_key(), get_test_did(), get_test_rid(), get_test_gid(), get_test_oid, get_test_behaviour

Examples

ckanr_settings()

Description

Configure default CKAN settings

Usage

ckanr_setup(
  url = "https://demo.ckan.org/",
  key = NULL,
  test_url = NULL,
  test_key = NULL,
  test_did = NULL,
  test_rid = NULL,
  test_gid = NULL,
  test_oid = NULL,
  test_behaviour = NULL,
  proxy = NULL
)

Arguments

Details

ckanr_setup() sets CKAN connection details. If you do not specify a URL or key, the functions use the default URL and API key.

ckanr automated tests require a valid CKAN URL, a privileged API key for that URL, and the IDs of an existing dataset and an existing resource.

The writing tests (create, update, delete) can fail for two reasons. One reason is failures in ckanr code. The tests aim to detect these failures. The other reason is failures in the configured CKAN. These failures are not necessarily a problem with ckanr code, but they stop the tests from proving otherwise.

If you set test_behaviour to "SKIP", writing tests skip when the configured test CKAN fails. This helps you test the other functions even when you have no write access to a CKAN instance.

If you set test_behaviour to "FAIL", the tester finds problems with both the configured test CKAN and the writing functions.

Value

(invisible) Called for its side effects; sets default and test CKAN settings in environment variables and returns invisibly.

Examples

# CKAN users without admin/editor privileges could run:
ckanr_setup(url = "https://demo.ckan.org/")

# Privileged CKAN editor/admin users can run:
ckanr_setup(url = "https://demo.ckan.org/", key = "some-CKAN-API-key")

# ckanR developers/testers can either use the Codespaces/devcontainer test suite
# which automatically sets up all test credentials, or run:
ckanr_setup(
  url = "https://demo.ckan.org/", key = "some-CKAN-API-key",
  test_url = "http://test-ckan.gov/", test_key = "test-ckan-API-key",
  test_did = "test-ckan-dataset-id", test_rid = "test-ckan-resource-id",
  test_gid = "test-group-name", test_oid = "test-organzation-name",
  test_behaviour = "FAIL"
)

# Not specifying the default CKAN URL will reset the CKAN URL to its default
# "https://demo.ckan.org/":
ckanr_setup()

# set a proxy
ckanr_setup(proxy = crul::proxy("64.251.21.73:8080"))
ckanr_settings()
## run without setting proxy to reset to no proxy
ckanr_setup()
ckanr_settings()

Description

These functions still work but will be removed (defunct) in the next version.

Details

• ds_create_dataset(): Another function in this package already provides this functionality. See function resource_create()

Description

Inspect and update CKAN's runtime-editable configuration keys.

Usage

config_option_list(
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

config_option_show(
  option_key,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

config_option_update(
  options,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-ckan-key")
config_option_list()
config_option_update(list("ckan.site_title" = "My Portal"))

## End(Not run)

Description

Authorized user's dashboard activity stream

Usage

dashboard_activity_list(
  limit = 31,
  offset = 0,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
# Setup
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

# get activity
(res <- dashboard_activity_list())

## End(Not run)

Description

Number of new activities of an authorized user

Usage

dashboard_count(
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Details

CKAN does not count activities from the user herself, but they appear in the dashboard. Users do not want notices about things they did themselves.

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
# Setup
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

# count
dashboard_new_activities_count()

## End(Not run)

Description

Permanently purge a dataset

Usage

dataset_purge(id, url = get_default_url(), key = get_default_key(), ...)

Arguments

Value

(logical) TRUE when the function purges the dataset successfully.

Examples

## Not run: 
dataset_purge("dataset-id")

## End(Not run)

Description

Wrappers for datastore_upsert, datastore_delete, datastore_records_delete, datastore_info, datastore_function_create, datastore_function_delete, and datastore_run_triggers. ds_search() and ds_create() cover read/create; these helpers complete the write/info coverage with the CKAN 2.12 parameters (include_records, include_meta, include_fields_schema, argmode) available from the start. See https://docs.ckan.org/en/2.12/maintaining/datastore.html#the-data-api.

Usage

ds_upsert(
  resource_id,
  records = NULL,
  method = "upsert",
  force = FALSE,
  include_records = FALSE,
  calculate_record_count = "background",
  dry_run = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

ds_delete(
  resource_id = NULL,
  filters = NULL,
  force = FALSE,
  include_deleted_records = FALSE,
  calculate_record_count = "background",
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

ds_records_delete(
  resource_id,
  filters,
  force = FALSE,
  include_deleted_records = FALSE,
  calculate_record_count = "background",
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

ds_info(
  resource_id,
  include_meta = TRUE,
  include_fields_schema = TRUE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

ds_function_create(
  name,
  rettype = "trigger",
  definition,
  or_replace = FALSE,
  argmode = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

ds_function_delete(
  name,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

ds_run_triggers(
  resource_id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
ds_info(resource_id = "my-resource-id")
ds_upsert(resource_id = "my-resource-id",
  records = list(list(a = 1, b = "xyz")), method = "upsert")

## End(Not run)

Description

Lightweight wrappers for CKAN's status_show and help_show actions.

Usage

status_show(url = get_default_url(), key = get_default_key(), as = "list", ...)

help_show(
  name,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/")
status_show()
help_show("package_search")

## End(Not run)

Description

BEWARE: This function does not work yet.

Usage

ds_create(
  resource_id = NULL,
  resource = NULL,
  force = FALSE,
  aliases = NULL,
  fields = NULL,
  records = NULL,
  primary_key = NULL,
  indexes = NULL,
  include_records = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(
  url = "https://demo.ckan.org/",
  key = getOption("ckan_demo_key")
)

# create a package
(res <- package_create("foobarrrrr", author = "Jane Doe"))

# then create a resource
file <- system.file("examples", "actinidiaceae.csv", package = "ckanr")
(xx <- resource_create(
  package_id = res$id,
  description = "my resource",
  name = "bears",
  upload = file,
  rcurl = "http://google.com"
))
ds_create(resource_id = xx$id, records = iris, force = TRUE)
resource_show(xx$id)

## End(Not run)

Description

Datastore - create a new resource on an existing dataset

Usage

ds_create_dataset(
  package_id,
  name,
  path,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Details

This function is deprecated and will be defunct in the next version of this package. Use resource_create() instead. For example, replace ds_create_dataset(package_id, name, path) with resource_create(package_id, name = name, upload = path).

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

References

https://docs.ckan.org/en/2.12/api/index.html#ckan.logic.action.create.resource_create

Examples

## Not run: 
path <- system.file("examples", "actinidiaceae.csv", package = "ckanr")
ckanr_setup(url = "https://demo.ckan.org/", key = "my-demo-ckan-org-api-key")
ds_create_dataset(package_id = "testingagain", name = "mydata", path = path)

# Testing: see ?ckanr_setup to set test settings
ckanr_setup(
  test_url = "http://my-ckan.org/",
  test_key = "my-ckan-api-key",
  test_did = "an-existing-package-id",
  test_rid = "an-existing-resource-id"
)
ds_create_dataset(
  package_id = get_test_pid(), name = "mydata",
  path = system.file("examples",
    "actinidiaceae.csv",
    package = "ckanr"
  ),
  key = get_test_key(),
  url = get_test_url()
)

## End(Not run)

Description

Datastore - search or get a dataset from CKAN datastore

Usage

ds_search(
  resource_id = NULL,
  filters = NULL,
  q = NULL,
  plain = NULL,
  language = NULL,
  fields = NULL,
  offset = NULL,
  limit = NULL,
  sort = NULL,
  include_next_page = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Details

From the help for this method "The datastore_search action allows you to search data in a resource." If a DataStore resource belongs to a private CKAN resource, you can read it only with access to that resource. You must send the appropriate authorization.

CKAN 2.12+ filters accept advanced syntax: range operations (lt, lte, gt, gte, eq), lists mixing values and ranges, nested AND/OR via lists, and ⁠$or⁠ groups (see https://docs.ckan.org/en/2.12/maintaining/datastore.html#filters). The filters argument passes through untouched, so both classic ({"key1": "a"}) and advanced filters work. For large tables prefer keyset pagination (include_next_page = TRUE with sort = "_id asc") over large offset values.

If you set plain=FALSE, you enable the entire PostgreSQL full text search query language. You can find a listing of all available resources at the alias table_metadata full text search query language: https://www.postgresql.org/docs/9.1/static/datatype-textsearch.html#DATATYPE-TSQUERY

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://data.gov.au/")
rid <- "eef6a84b-ad44-446f-9cf9-fb5d135e3123"

ds_search(resource_id = rid)
ds_search(resource_id = rid, as = "table")
ds_search(resource_id = rid, as = "json")

ds_search(resource_id = rid, limit = 1, as = "table")
ds_search(resource_id = rid, q = "S*")

# Return selected fields
ds_search(
  resource_id = rid,
  fields = c("name", "amount"),
  as = "table"
)

# Match more than one field. CKAN applies the conditions together.
ds_search(
  resource_id = rid,
  filters = list(status = "active", category = "water"),
  fields = c("name", "status", "category"),
  as = "table"
)

## End(Not run)

Description

Datastore - search or get a dataset from CKAN datastore

Usage

ds_search_sql(
  sql,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://data.gov.au/")
sql <- 'SELECT * from "eef6a84b-ad44-446f-9cf9-fb5d135e3123" LIMIT 2'
ds_search_sql(sql, as = "table")
sql2 <- 'SELECT "Dog","TRI" from "eef6a84b-ad44-446f-9cf9-fb5d135e3123" LIMIT 2'
ds_search_sql(sql2, as = "table")

## End(Not run)

Description

These helpers wrap CKAN 2.12 ⁠file_*⁠ endpoints. Files are first-class entities in CKAN 2.12 (see https://docs.ckan.org/en/2.12/api/#ckan-logic-action-file and https://github.com/ckan/ckan/pull/9026). The target CKAN instance must run CKAN 2.12 or later; each wrapper calls ensure_action_available() so it fails clearly on older instances.

Usage

file_create(
  upload,
  name = NULL,
  storage = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_register(
  location = NULL,
  storage = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_show(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_delete(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_rename(
  id,
  name,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_pin(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_unpin(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_ownership_transfer(
  id,
  owner_id,
  owner_type,
  force = FALSE,
  pin = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

file_owner_scan(
  owner_id,
  owner_type,
  start = NULL,
  rows = NULL,
  sort = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Details

By default only sysadmins may call file_create(); see ckan.files.authenticated_uploads.allow in the CKAN docs for granting access to registered users.

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
f <- file_create(upload = "path/to/file.csv")
file_show(f$id)

## End(Not run)

Description

Create or remove follower relationships for a CKAN object. You must authenticate as a user with an API key. The key represents the follower.

Usage

dataset_follow(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

dataset_unfollow(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

dataset_am_following(id, url = get_default_url(), key = get_default_key(), ...)

group_follow(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

group_unfollow(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

group_am_following(id, url = get_default_url(), key = get_default_key(), ...)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-key")
dataset_follow("my-dataset")
dataset_am_following("my-dataset")
dataset_unfollow("my-dataset")

## End(Not run)

Description

Manage user-to-user follower relationships.

Usage

follow_user(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

unfollow_user(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

am_following_user(id, url = get_default_url(), key = get_default_key(), ...)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-key")
follow_user("demo-user")
am_following_user("demo-user")
unfollow_user("demo-user")

## End(Not run)

Description

Count how many objects of each type (or overall) a user follows.

See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.organization_followee_count for the official API contract.

Usage

followee_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

user_followee_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

dataset_followee_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

group_followee_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

organization_followee_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-key")
followee_count("demo-user")
user_followee_count("demo-user")
dataset_followee_count("demo-user")
organization_followee_count("demo-user")

## End(Not run)

Description

The function returns the objects that a user follows.

See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.organization_followee_list for the official API contract.

Usage

followee_list(
  id,
  q = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

user_followee_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

dataset_followee_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

group_followee_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

organization_followee_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-key")
followee_list("demo-user", q = "ckan")
dataset_followee_list("demo-user")
organization_followee_list("demo-user")

## End(Not run)

Description

Report follower totals for datasets, groups, organizations, or users.

See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.organization_follower_count for the official API contract.

Usage

dataset_follower_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

group_follower_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

user_follower_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

organization_follower_count(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-key")
dataset_follower_count("my-dataset")
group_follower_count("my-group")
organization_follower_count("my-organization")
user_follower_count("demo-user")

## End(Not run)

Description

The function returns the individual follower records for CKAN datasets, groups, organizations, or users.

See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.organization_follower_list for the official API contract.

Usage

dataset_follower_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

group_follower_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

user_follower_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

organization_follower_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-key")
dataset_follower_list("my-dataset")
group_follower_list("my-group")
organization_follower_list("my-organization")
user_follower_list("demo-user")

## End(Not run)

Description

Return a list of resource formats whose names contain a query string. See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.format_autocomplete for the official API contract.

Usage

format_autocomplete(
  q,
  limit = 5,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A character vector of matching format names. With as = "table", a data.frame; with as = "json", the raw JSON response.

References

https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.format_autocomplete

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

format_autocomplete(q = "csv")

## End(Not run)

Description

Return the CKAN site user. The site user is a special internal user that the web interface and background jobs use for internal operations. You must be a sysadmin to call this endpoint. See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.get_site_user for the official API contract.

Usage

get_site_user(
  defer_commit = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A ckan_user object. With as = "table", a data.frame; with as = "json", the raw JSON response.

References

https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.get_site_user

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

get_site_user()

## End(Not run)

Description

Return a list of group names that contain a query string. See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.group_autocomplete for the official API contract.

Usage

group_autocomplete(
  q,
  limit = 20,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list of group dictionaries, each with the keys name, title, and id. With as = "table", a data.frame; with as = "json", the raw JSON response.

References

https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.group_autocomplete

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

group_autocomplete(q = "data")

## End(Not run)

Description

Create a group

Usage

group_create(
  name = NULL,
  id = NULL,
  title = NULL,
  description = NULL,
  image_url = NULL,
  type = NULL,
  state = "active",
  approval_status = NULL,
  extras = NULL,
  packages = NULL,
  groups = NULL,
  users = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
# Setup
ckanr_setup(url = "https://demo.ckan.org", key = getOption("ckan_demo_key"))

# create a group
(res <- group_create("fruitloops2", description = "A group about fruitloops"))
res$users
res$num_followers

## End(Not run)

Description

Delete a group

Usage

group_delete(id, url = get_default_url(), key = get_default_key(), ...)

Arguments

Value

(logical) TRUE on success

Examples

## Not run: 
# Setup
ckanr_setup(url = "https://demo.ckan.org", key = getOption("ckan_demo_key"))

# create a group
(res <- group_create("lions", description = "A group about lions"))

# show the group
group_show(res$id)

# delete the group
group_delete(res)

## End(Not run)

Description

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

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
group_list(limit = 3)
group_list(limit = 3, as = "json")
group_list(limit = 3, as = "table")

## End(Not run)

Description

List groups the current user can edit

Usage

group_list_authz(
  type = "group",
  groups = NULL,
  all_fields = FALSE,
  include_dataset_count = TRUE,
  include_extras = FALSE,
  include_tags = FALSE,
  include_groups = FALSE,
  include_users = FALSE,
  available_only = FALSE,
  am_member = FALSE,
  offset = NULL,
  limit = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
group_list_authz()

## End(Not run)

Description

Make a user a member of a group

Usage

group_member_create(
  id,
  username,
  role,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
group_member_create("my-group", username = "demo-user", role = "member")

## End(Not run)

Description

Remove a user from a group

Usage

group_member_delete(
  id,
  username,
  url = get_default_url(),
  key = get_default_key(),
  ...
)

Arguments

Value

(logical) TRUE on success

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
group_member_delete("my-group", username = "demo-user")

## End(Not run)

Description

Return the datasets (packages) that belong to a group. See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.group_package_show for the official API contract.

Usage

group_package_show(
  id,
  limit = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list of ckan_package objects. With as = "table", a data.frame; with as = "json", the raw JSON response.

References

https://docs.ckan.org/en/2.11/api/#ckan.logic.action.get.group_package_show

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

res <- group_list()
group_package_show(res[[1]]$name)
group_package_show(res[[1]], limit = 5, as = "table")

## End(Not run)

Description

Update a group's metadata

Usage

group_patch(
  x,
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
# Setup
ckanr_setup(url = "https://demo.ckan.org", key = getOption("ckan_demo_key"))

# Create a package
(res <- group_create("hello-my-world2"))

# Get a resource
grp <- group_show(res$id)
grp$title
grp$author_email

# Make some changes
x <- list(title = "!hello world!", maintainer_email = "[email protected]")
group_patch(x, id = grp)

## End(Not run)

Description

IMPORTANT: You must be a sysadmin to purge a group. Purging a group cannot be undone: it completely removes the group from the CKAN database, whereas deleting a group only marks it as deleted. Datasets in the group remain, just no longer in the purged group. See https://docs.ckan.org/en/2.11/api/#ckan.logic.action.delete.group_purge for the official API contract.

Usage

group_purge(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

References

https://docs.ckan.org/en/2.11/api/#ckan.logic.action.delete.group_purge

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org", key = getOption("ckan_demo_key"))

# create a group
(res <- group_create("foobar-group",
  title = "Foo bars",
  description = "love foo bars"
))

# delete the group just created
res$id
group_delete(id = res$id)

# purge the group just deleted
res$id
group_purge(id = res$id)

## End(Not run)

Description

Show a group

Usage

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

Arguments

Details

By default the function drops the help and success slots. It returns only the result slot. If you want raw json, request as = 'json'. Then you parse the result yourself to get the help slot.

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

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)

Description

Update a group

Usage

group_update(
  x,
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
# Setup
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))

# First, create a group
grp <- group_create("water-bears2")
group_show(grp)

## update just chosen things
# Make some changes
x <- list(description = "A group about water bears and people that love them")

# Then update the packge
group_update(x, id = grp)

## End(Not run)

Description

Manage the RQ/Redis job queue of CKAN. You must have sysadmin access.

Usage

job_list(
  queues = NULL,
  limit = NULL,
  ids_only = FALSE,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

job_show(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

job_clear(
  queues = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

job_cancel(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = "my-ckan-key")
job_list()

## End(Not run)

Description

Return the list of licenses available for datasets on the site.

Usage

license_list(
  id,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
license_list()
license_list(as = "table")
license_list(as = "json")

## End(Not run)

Description

Create or update a membership via member_* endpoints

Usage

member_create(
  id,
  object,
  object_type,
  capacity,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
member_create("my-group", object = "demo-user", object_type = "user", capacity = "member")

## End(Not run)

Description

Remove a membership via member_* endpoints

Usage

member_delete(
  id,
  object,
  object_type,
  url = get_default_url(),
  key = get_default_key(),
  ...
)

Arguments

Value

(logical) TRUE on success

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
member_delete("my-group", object = "demo-user", object_type = "user")

## End(Not run)

Description

List members for a group or organization

Usage

member_list(
  id,
  object_type = NULL,
  capacity = NULL,
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments

Value

A list (default), table, or JSON string with the CKAN response, controlled by the as parameter.

Examples

## Not run: 
ckanr_setup(url = "https://demo.ckan.org/", key = getOption("ckan_demo_key"))
member_list("my-group", object_type = "user")

## End(Not run)

Description

Report available member roles

Usage

member_roles_list(
  group_type = "organization",
  url = get_default_url(),
  key = get_default_key(),
  as = "list",
  ...
)

Arguments