R/ba_germplasm_breedingmethods_details.R

In c5sire/brapi: Client to Access Breeding Databases Using BrAPI

#' ba_germplasm_breedingmethods_details
#'
#' Retrieve details of a germplasm breeding method available on a BrAPI compliant
#' database server.
#'
#' @param con list, brapi connection object
#' @param breedingMethodDbId character, the internal database identifier for a
#'                           germplasm breeding method of which the details are
#'                           to be retrieved e.g. "bm1"; \strong{REQUIRED ARGUMENT}
#'                           with default: ""
#' @param rclass character, class of the object to be returned;  default: "tibble"
#'               , possible other values: "data.frame"/"list"/"json"
#'
#' @return An object of class as defined by rclass containing the details of the
#'         requested germplasm breeding method.
#'
#' @note Tested against: test-server
#' @note BrAPI Version: 1.2
#' @note BrAPI Status: active
#'
#' @author Reinhard Simon, Maikel Verouden
#' @references \href{https://github.com/plantbreeding/API/blob/V1.2/Specification/Germplasm/BreedingMethods_BreedingMethodDbId_GET.md}{github}
#'
#' @example inst/examples/ex-ba_germplasm_breedingmethods_details.R
#'
#' @import tibble
#' @export
ba_germplasm_breedingmethods_details <- function(con = NULL,
                                        breedingMethodDbId = "",
                                        rclass = c("tibble", "data.frame", "list", "json")) {
  ba_check(con = con, verbose = FALSE, brapi_calls = "breedingmethods/breedingMethodDbId")
  check_character(breedingMethodDbId)
  check_req(breedingMethodDbId)
  rclass <- match.arg(rclass)

  brp <- get_brapi(con = con)
  callurl <- paste0(brp, "breedingmethods/", breedingMethodDbId)

  try({
    resp <- brapiGET(url = callurl, con = con)
    cont <- httr::content(x = resp, as = "text", encoding = "UTF-8")
    out <- NULL
    if (rclass %in% c("json", "list")) {
      out <- dat2tbl(res = cont, rclass = rclass)
    }
    if (rclass %in% c("tibble", "data.frame")) {
      out <- dat2tbl(res = cont, rclass = rclass, result_level = "result")
    }
    if (!is.null(out)) {
      class(out) <- c(class(out), "ba_germplasm_breedingmethods_details")
    }
    show_metadata(resp)
    return(out)
  })
}