R/ba_samples_save.R

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

#' ba_samples_save
#'
#' Save sample data available on a brapi server.
#'
#' @param con list, brapi connection object
#' @param sampleData list of sample details.
#'
#' @author Reinhard Simon
#' @references \href{https://github.com/plantbreeding/API/blob/master/Specification/Samples/TakeASample.md}{github}
#' @example inst/examples/ex-ba_samples_save.R
#' @return character a unique sample ID assigned by the server
#' @family phenotyping
#' @export
ba_samples_save <- function(con = NULL,
                            sampleData = list()) {
  ba_check(con = con, verbose = FALSE, brapi_calls = "samples")
  stopifnot(is.list(sampleData))
  stopifnot(all(c("plotId", "plantId", "takenBy", "sampleDate", "sampleType",
                  "tissueType", "notes") %in% names(sampleData)))
  brp <- get_brapi(con = con)
  call_samples <- paste0(brp, "samples/")
  try({
    res <- brapiPUT(url = call_samples, body = sampleData, con = con)
    res <- httr::content(x = res)
    out <- res$result$sampleId
    if (!is.null(out)) {
      class(out) <- c(class(out), "ba_samples")
    }
    show_metadata(res)
    return(out)
  })
}