R/rt_status_opgroup.R

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

#' Retrieve the status of all Taxa in an Operational Group
#'
#' @param opgroup_id {`integer(1)` \[**required**\]}\cr{}
#'                   identifier of the operational group (see the list of
#'                   operational groups [rt_operational_groups()])
#' @param size {`integer(1)` \[default = `2000`\]}\cr{}
#'             The number of lines returned per page (maximum = 2000)
#' @inheritParams rt_taxa_search
#'
#' @examples
#' \dontrun{
#'     rt_status_opgroup(opgroup_id = 706)
#' }
#'
#' @seealso the list of operational groups [`rt_operational_groups()`]
#'
#' @export
rt_status_opgroup = function(opgroup_id, page = 1, size = 2000) {

  check_required_arg(opgroup_id, "retrieve statuses of an operational group")

  stopifnot("'opgroup_id' must be a numeric" = is.numeric(opgroup_id))
  stopifnot("'page' must be a numeric"       = is.numeric(page))
  stopifnot("'size' must be a numeric"       = is.numeric(size))

  api_query = rt_GET("status/findByOperationalGroup/", opgroup_id,
                     query = list(page = page,
                                  size = size))

  parse_taxa(api_query)
}