R/group_patch.R

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

#' Update a group's metadata
#'
#' @export
#' @param x (list) A list with key-value pairs
#' @param id (character) Resource ID to update (required)
#' @template args
#' @template key
#' @examples \dontrun{
#' # 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 = "hello@@world.com")
#' group_patch(x, id = grp)
#' }
group_patch <- function(x, id, url = get_default_url(), key = get_default_key(),
  as = 'list', ...) {

  id <- as.ckan_group(id, url = url)
  if (!inherits(x, "list")) {
    stop("x must be of class list", call. = FALSE)
  }
  x$id <- id$id
  res <- ckan_POST(url, method = 'group_patch',
                   body = tojun(x, TRUE), key = key,
                   encode = "json", headers = ctj(), opts = list(...))
  switch(as, json = res, list = as_ck(jsl(res), "ckan_group"), table = jsd(res))
}