R/group_list.R

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

#' List groups.
#'
#' @export
#'
#' @param sort Field to sort on. You can specify ascending (e.g., score desc) or
#' descending (e.g., score asc), sort by two fields (e.g., score desc, price asc),
#' or sort by a function (e.g., sum(x_f, y_f) desc, which sorts by the sum of
#' x_f and y_f in a descending order).
#' @param groups (character) A list of names of the groups to return, if given
#' only groups whose names are in this list will be returned
#' @param all_fields (logical) Return full group dictionaries instead of just
#' names. Default: `FALSE`
#' @template paging
#' @template args
#' @template key
#' @examples \dontrun{
#' group_list(limit = 3)
#' group_list(limit = 3, as = 'json')
#' group_list(limit = 3, as = 'table')
#' }
group_list <- function(offset = 0, limit = 31, sort = NULL, groups = NULL,
  all_fields = FALSE, url = get_default_url(), key = get_default_key(),
  as = 'list', ...) {

  args <- cc(list(offset = offset, limit = limit, sort = sort,
                  groups = groups, all_fields = as_log(all_fields)))
  res <- ckan_GET(url, 'group_list', args, key = key, opts = list(...))
  switch(as, json = res,
         list = lapply(jsl(res), as.ckan_group, url = url),
         table = jsd(res))
}