brapi_get_germplasm: get /germplasm

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

get /germplasm

Description

Get a filtered list of Germplasm

Usage

brapi_get_germplasm(
  con = NULL,
  germplasmPUI = "",
  germplasmDbId = "",
  germplasmName = "",
  commonCropName = "",
  accessionNumber = "",
  collection = "",
  genus = "",
  species = "",
  studyDbId = "",
  synonym = "",
  parentDbId = "",
  progenyDbId = "",
  externalReferenceID = "",
  externalReferenceSource = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
germplasmPUI	character; required: FALSE; Permanent unique identifier (DOI, URI, etc.).
germplasmDbId	character; required: FALSE; Unique internal germplasm database identifier to filter by.
germplasmName	character; required: FALSE; Name of the germplasm
commonCropName	character; required: FALSE; The common crop name related to this germplasm.
accessionNumber	character; required: FALSE; Unique identifiers for accessions within a genebank.
collection	character; required: FALSE; A specific panel/collection/population name this germplasm belongs to.
genus	character; required: FALSE; Genus name to identify germplasm.
species	character; required: FALSE; Species name to identify germplasm.
studyDbId	character; required: FALSE; Search for Germplasm that are associated with a particular unique internal Study database identifier.
synonym	character; required: FALSE; Alternative name or ID used to reference this germplasm.
parentDbId	character; required: FALSE; Search for Germplasm with this parent.
progenyDbId	character; required: FALSE; Search for Germplasm with this child.
externalReferenceID	character; required: FALSE; An external reference ID. Could be a simple string or a URI. (use with externalReferenceSource parameter)
externalReferenceSource	character; required: FALSE; An identifier for the source system or database of an external reference (use with externalReferenceID parameter).
page	integer; required: FALSE; Used to request a specific page of data to be returned. The page indexing starts at 0 (the first page is page = 0). Default is 0.
pageSize	integer; required: FALSE; The size of the pages to be returned. Default is 1000.

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-germplasm: brapi_get_attributes(), brapi_get_attributevalues(), brapi_get_search_attributes_searchResultsDbId(), brapi_get_search_attributevalues_searchResultsDbId(), brapi_get_search_germplasm_searchResultsDbId(), brapi_post_search_attributes(), brapi_post_search_attributevalues(), brapi_post_search_germplasm()

Other Germplasm: brapi_get_search_germplasm_searchResultsDbId(), brapi_post_search_germplasm()

Examples

## Not run: 
con <- brapi_db()$testserver
brapi_get_germplasm(con = con)

## End(Not run)

mverouden/brapir-v2 documentation built on April 22, 2022, 9:24 a.m.