R/brapi_get_studies.R

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

#' @title
#' get /studies
#'
#' @description
#' Get the Studies
#'
#' @param con list; required: TRUE; BrAPI connection object
#' @param commonCropName character; required: FALSE; Common name for the crop associated with this study
#' @param studyTypeDbId character; required: FALSE; Filter based on study type unique identifier
#' @param programDbId character; required: FALSE; Program filter to only return studies associated with given program id.
#' @param locationDbId character; required: FALSE; Filter by location
#' @param seasonDbId character; required: FALSE; Filter by season or year
#' @param trialDbId character; required: FALSE; Filter by trial
#' @param studyDbId character; required: FALSE; Filter by study DbId
#' @param active logical; required: FALSE; Filter active status true/false.; default: NA, other possible values: TRUE | FALSE
#' @param sortBy character; required: FALSE; Name of the field to sort by.
#' @param sortOrder character; required: FALSE; Sort order direction. Ascending/Descending.; default: "", other possible values: "asc"|"ASC"|"desc"|"DESC"
#' @param page integer; required: FALSE; Which result page is requested. The page indexing starts at 0 (the first page is 'page'= 0). Default is `0`.
#' @param pageSize integer; required: FALSE; The size of the pages to be returned. Default is `1000`.
#'
#' @details
#' Get list of studies
#'
#' * StartDate and endDate should be ISO8601 format for dates
#'
#' @return data.frame
#'
#' @author brapir generator package
#'
#' @references \href{https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI/1.3#/Studies/get_studies }{BrAPI SwaggerHub}
#'
#' @family brapi_1.3
#' @family Studies
#'
#' @export
brapi_get_studies <- function(con = NULL, commonCropName = '', studyTypeDbId = '', programDbId = '', locationDbId = '', seasonDbId = '', trialDbId = '', studyDbId = '', active = NA, sortBy = '', sortOrder = '', page = 0, pageSize = 1000) {
  ## 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 = "")
  ## Obtain the call url
  callurl <- brapi_GET_callURL(usedArgs = usedArgs,
                               callPath = "/studies",
                               reqArgs = "",
                               packageName = "BrAPI",
                               callVersion = 1.3)

  try({
    ## Make the call and receive the response
    resp <- brapi_GET(url = callurl, 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_get_studies")
  ## Show pagination information from metadata
  brapi_serverinfo_metadata(cont)
  return(out)
}