#' @title
#' get /germplasm/\{germplasmDbId\}/pedigree
#'
#' @description
#' Get the pedigree details of a specific Germplasm
#'
#' @param con list; required: TRUE; BrAPI connection object
#' @param germplasmDbId character; required: TRUE; the internal id of the germplasm
#' @param notation character; required: FALSE; text representation of the pedigree
#' @param includeSiblings logical; required: FALSE; include array of siblings in response; default: NA, other possible values: TRUE | FALSE
#'
#' @details Get the parentage information of a specific Germplasm
#'
#' @return data.frame
#'
#' @author brapir generator package
#'
#' @references \href{https://app.swaggerhub.com/apis/PlantBreedingAPI/BrAPI/1.3#/Germplasm/get_germplasm__germplasmDbId__pedigree }{BrAPI SwaggerHub}
#'
#' @family brapi_1.3
#' @family Germplasm
#'
#' @export
brapi_get_germplasm_germplasmDbId_pedigree <- function(con = NULL, germplasmDbId = '', notation = '', includeSiblings = NA) {
## 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 = "germplasmDbId")
## Obtain the call url
callurl <- brapi_GET_callURL(usedArgs = usedArgs,
callPath = "/germplasm/{germplasmDbId}/pedigree",
reqArgs = "germplasmDbId",
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_germplasm_germplasmDbId_pedigree")
## Show pagination information from metadata
brapi_serverinfo_metadata(cont)
return(out)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.