R/ba_programs_search_post.R

In CIP-RIU/brapi: Client to Access Breeding Databases Using BrAPI

#' ba_programs_search_post
#'
#' Search breeding programs via a POST method
#'
#' @param con list, brapi connection object
#' @param abbreviation character, search programs by program abbreviation;
#'                     default: ""
#' @param leadPerson character, search programs by program leader name; default:
#'                   ""
#' @param name character, search programs by program name; default: ""
#' @param objective character, search programs by program objective; default: ""
#' @param programDbId character, search programs by program database identifier;
#'                    default: ""
#' @param commonCropName character, search programs by commonCropName; default:
#'                       ""
#' @param pageSize integer, items per page to be returned; default: 1000
#' @param page integer, the requested page to be returned; default: 0 (1st page)
#' @param rclass character, class of the object to be returned;  default: "tibble"
#'               , possible other values: "json"/"list"/"data.frame"
#'
#' @details Searching by commonCropName has not be tested yet, because none of
#'          the databases support this feature yet (not even the test-server)!
#'
#' @return An object of class as defined by rclass containing the breeding
#'         programs matching the search criteria.
#'
#' @note Tested against: test-server
#' @note BrAPI Version: 1.0, 1.1, 1.2
#' @note BrAPI Status: active
#'
#' @author Reinhard Simon, Maikel Verouden
#' @references \href{https://github.com/plantbreeding/API/blob/V1.2/Specification/Programs/ProgramSearch.md}{github}
#' @family brapicore
#' @example inst/examples/ex-ba_programs_search_post.R
#' @import httr
#' @export
ba_programs_search_post <- function(con = NULL,
                               abbreviation = "",
                               leadPerson = "",
                               name = "",
                               objective = "",
                               programDbId = "",
                               commonCropName = "",
                               pageSize = 1000,
                               page = 0,
                               rclass = c("tibble", "data.frame",
                                          "list", "json")) {
  ba_check(con = con, verbose = FALSE, brapi_calls = "programs-search")
  check_character(abbreviation, leadPerson, name, objective, programDbId, commonCropName)
  rclass <- match.arg(rclass)

  brp <- get_brapi(con = con)
  callurl <- paste0(brp, "programs-search")

  try({
    body <- get_body(abbreviation = abbreviation,
                     leadPerson = leadPerson,
                     name = name,
                     objective = objective,
                     programDbId = programDbId,
                     commonCropName = commonCropName,
                     pageSize = pageSize,
                     page = page)

    resp <- brapiPOST(url = callurl, body = body, con = con)
    cont <- httr::content(x = resp, as = "text", encoding = "UTF-8")
    out <- dat2tbl(res = cont, rclass = rclass)
    class(out) <- c(class(out), "ba_programs_search_post")
    show_metadata(resp)
    return(out)
  })
}