R/cr_licenses.R

In rcrossref: Client for Various 'CrossRef' 'APIs'

#' Search CrossRef licenses
#'
#' @export
#' @family crossref
#' @param query Query terms
#' @param offset Number of record to start at, from 1 to infinity.
#' @param limit Number of results to return in the query. Not relavant when
#' searching with specific dois. Default: 20. Max: 1000
#' @param order (character) Sort order, one of 'asc' or 'desc'
#' @param .progress Show a `plyr`-style progress bar? Options are "none",
#' "text", "tk", "win, and "time".  See [plyr::create_progress_bar()]
#' for details of each.
#' @param ... Named parameters passed on to [crul::HttpClient()]
#' @param parse (logical) Whether to output json `FALSE` or parse to
#' list `TRUE`. Default: `FALSE`
#' @template sorting
#'
#' @details BEWARE: The API will only work for CrossRef DOIs.
#' @references
#' https://github.com/CrossRef/rest-api-doc
#' @details NOTE: The API route behind this function does not support filters
#' any more, so the `filter` parameter has been removed.
#'
#' @examples \dontrun{
#' cr_licenses()
#' # query for something, e.g. a publisher
#' cr_licenses(query = 'elsevier')
#'
#' # Low level function - does no parsing to data.frame, get json or a list
#' cr_licenses_()
#' cr_licenses_(query = "elsevier")
#' cr_licenses_(query = "elsevier", parse=TRUE)
#' }

`cr_licenses` <- function(query = NULL, offset = NULL, limit = NULL,
  sort = NULL, order = NULL, .progress="none", ...) {

  calls <- names(sapply(match.call(expand.dots = TRUE), deparse))[-1]
  if ("filter" %in% calls)
    stop("The parameter filter has been removed")

  check_limit(limit)
  args <- cr_compact(list(query = query, offset = offset, rows = limit,
                          sort = sort, order = order))

  tmp <- licenses_GET(args = args, parse = TRUE, ...)
  df <- tibble::as_tibble(bind_rows(lapply(tmp$message$items, data.frame,
                                stringsAsFactors = FALSE)))
  meta <- parse_meta(tmp)
  list(meta = meta, data = df)
}

#' @export
#' @rdname cr_licenses
`cr_licenses_` <- function(query = NULL, offset = NULL, limit = NULL,
  sort = NULL, order = NULL, .progress="none", parse = FALSE, ...) {

  check_limit(limit)
  args <- cr_compact(list(query = query, offset = offset, rows = limit,
                          sort = sort, order = order))
  licenses_GET(args = args, parse = parse, ...)
}

licenses_GET <- function(args, parse, ...) {
  cr_GET("licenses", args, todf = FALSE, on_error = stop, parse = parse, ...)
}