brapi_get_attributes: get /attributes

View source: R/brapi_get_attributes.R

brapi_get_attributesR Documentation

get /attributes

Description

Get the Germplasm Attributes

Usage

brapi_get_attributes(
  con = NULL,
  attributeCategory = "",
  attributeDbId = "",
  attributeName = "",
  germplasmDbId = "",
  externalReferenceID = "",
  externalReferenceSource = "",
  page = 0,
  pageSize = 1000
)

Arguments

con

list; required: TRUE; BrAPI connection object

attributeCategory

character; required: FALSE; The general category for the attribute. very similar to Trait class.

attributeDbId

character; required: FALSE; The unique id for an attribute

attributeName

character; required: FALSE; The human readable name for an attribute

germplasmDbId

character; required: FALSE; Get all attributes associated with this unique germplasm database identifier.

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.

Details

Retrieve available attributes.

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-germplasm: brapi_get_attributevalues(), brapi_get_germplasm(), 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 Attributes: brapi_get_search_attributes_searchResultsDbId(), brapi_post_search_attributes()

Examples

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

## End(Not run)


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