R/cp_children.R

In rcol: Catalogue of Life Client

#' Children
#'
#' @export
#' @param dataset_key (character/integer/numeric) dataset identifier
#' @param taxon_id (character/integer/numeric) taxon identifier
#' @param ... curl options passed on to [crul::verb-GET]
#' @return list with two slots
#' - `result` (data.frame/tibble): results, a zero row data.frame
#' if no results found
#' - `meta` (data.frame/tibble): number of results found
#' @examples
#' chk <- function(x) {
#'   z <- tryCatch(crul::ok(x), error = function(e) e)
#'   if (inherits(z, "error")) FALSE else z
#' }
#' if (chk("https://api.catalogueoflife.org/version")) {
#' z <- cp_children(dataset_key=1000, taxon_id='1')
#' z
#' z$result
#' if (NROW(z$result) > 0) {
#' z$result$scientificName
#' z$result$created
#' }
#' }
cp_children <- function(dataset_key, taxon_id, ...) {
  assert(dataset_key, c("character", "integer", "numeric"))
  assert(taxon_id, c("character", "integer", "numeric"))
  path <- sprintf("dataset/%s/taxon/%s/children", dataset_key, taxon_id)
  tmp <- cp_GET(col_base(), path, ...)
  tmp$result <- handle_taxon(tmp$result)
  tmp <- cp_meta(tmp)
  return(tmp)
}