R/brapi_put_methods_methodDbId.R

In mverouden/brapir: Client to Access BrAPI Compliant Plant Breeding Databases

#' @title
#' put /methods/\{methodDbId\}
#'
#' @description
#' Update an existing Method
#'
#' @param con list; required: TRUE; BrAPI connection object
#' @param methodDbId character; required: TRUE; Id of the method to update details of.; default: "".
#' @param class character; required: FALSE; Method class (examples: "Measurement", "Counting", "Estimation", "Computation", etc.); default: "".
#' @param description character; required: FALSE; Method description.; default: "".
#' @param formula character; required: FALSE; For computational methods i.e., when the method consists in assessing the trait by computing measurements, write the generic formula used for the calculation; default: "".
#' @param methodName character; required: FALSE; Human readable name for the method; default: "".
#' @param ontologyReference list; required: FALSE; The ontologyReference list should contain links to various ontology documentation (URL and type) supplied as a dataframe, an unique ontology database identifier, an ontology name and an ontology version (no specific format). In the Examples section an example on how to specify this list is provided; default: list()
#' @param reference character; required: FALSE; Bibliographical reference describing the method.; default: "".
#'
#' @details Update the details of an existing method
#'
#' @return data.frame
#'
#' @author brapir generator package
#'
#' @references \href{https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI/1.3#/Observation%20Variables/put_methods__methodDbId_ }{BrAPI SwaggerHub}
#'
#' @family brapi_1.3
#' @family Observation Variables
#'
#' @examples
#' \dontrun{
#'
#' # Create a connection object
#' con <- brapi_db()$testserver
#'
#' # Create an ontologyReference example list object
#' # ontologyDbId should be specified as an existing one (see get /ontologies) or
#' # left empty (some servers might generate a new ontologyDbId).
#' ontologyReference <- list(
#'   documentationLinks = data.frame(URL = "https://ontology.org/m1",
#'                                   type = "WEBPAGE"),
#'   ontologyDbId = "MO_123",
#'   ontologyName = "Ontology.org",
#'   version = "17")
#'
#' # Make put /methods/{methodDbId} call
#' brapi_put_methods_methodDbId(con = con,
#'                              methodDbId = "m1",
#'                              class = "Numeric",
#'                              description = "Standard measuring tape",
#'                              formula = "sqrt(a^2 + b^2) = c",
#'                              methodName = "Tape Measurement",
#'                              ontologyReference = ontologyReference,
#'                              reference = "goggles.com")
#' }
#'
#' @export
brapi_put_methods_methodDbId <- function(con = NULL, methodDbId = '', class = '', description = '', formula = '', methodName = '', ontologyReference = list(), reference = '') {
  ## Create a list of used arguments
  usedArgs <- brapi_usedArgs(origValues = FALSE)
  ## Check if BrAPI server can be reached given the connection details
  brapi_checkCon(con = usedArgs[["con"]], verbose = FALSE)
  ## Check validity of used and required arguments
  brapi_checkArgs(usedArgs, reqArgs = "methodDbId")
  ## Obtain the call url
  callurl <- brapi_PUT_callURL(usedArgs = usedArgs,
                               callPath = "/methods/{methodDbId}",
                               reqArgs = "methodDbId",
                               packageName = "BrAPI",
                               callVersion = 1.3)
  ## Build the Body
  callbody <- brapi_PUT_callBody(usedArgs = usedArgs,
                                 reqArgs = "methodDbId")
  try({
    ## Make the call and receive the response
    resp <- brapi_PUT(url = callurl, body = callbody, usedArgs = usedArgs)
    ## Extract the content from the response object in human readable form
    cont <- httr::content(x = resp, as = "text", encoding = "UTF-8")
    ## Convert the content object into a data.frame
    out <- brapi_result2df(cont, usedArgs)
  })
  ## Set class of output
  class(out) <- c(class(out), "brapi_put_methods_methodDbId")
  ## Show pagination information from metadata
  brapi_serverinfo_metadata(cont)
  return(out)
}