R/rt_source_uses.R

In Rekyt/rtaxref: An R client for TaxRef the French Taxonomical Database

#' Retrieve the list of source uses in TAXREF
#'
#' TAXREF references many publications across its documentation. The different
#' sources are used for different reasons. This function returns the list of
#' usages for a source when no arguments are provided, otherwise returns the
#' specific type of use.
#'
#' @param usage_id {`NULL` or `numeric(1)` \[default = `NULL`\]}\cr{}
#'                 the id of a source use in TAXREF
#'
#' @examples
#' \dontrun{rt_source_uses(usage_id = 276)}
#'
#' @export
rt_source_uses = function(usage_id = NULL) {

  stopifnot(
    "'usage_id' must be a numeric or NULL" =
      is.numeric(usage_id) | is.null(usage_id)
  )

  api_query = rt_GET("sourceUses/", usage_id)

  parse_taxa(api_query)
}