R/dc_members.R

#' DataCite REST API: members
#'
#' @export
#' @param query (character) Query string, e.g., data center name
#' @param member_type (character) member type, one of "allocating"
#' or "non-allocating"
#' @param region (character) Geographic region, one of "amer", "apac",
#' or "emea"
#' @param year (numeric/integer) year member joined DataCite
#' @param offset (numeric/integer) result offset, the record to start at
#' @param rows (numeric/integer) results per page
#' @param ... curl options passed on to [crul::HttpClient]
#' @seealso [dc_member()]
#' @family rest api methods
#' @examples \dontrun{
#' dc_members(query = "ands")
#' }
dc_members <- function(query = NULL, member_type = NULL, region = NULL,
	year = NULL, offset = 0, rows = 25, ...) {

	args <- dc_compact(list(query = query, `member-type` = member_type,
		region = region, year = year, `page[offset]` = offset,
    `page[size]` = rows))
  dc_rest_GET("members", args = args, ...)
}

Try the rdatacite package in your browser

Any scripts or data that you put into this service are public.

rdatacite documentation built on May 8, 2019, 1:03 a.m.