brapi_get_samples: get /samples

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

get /samples

Description

Get the Samples

Usage

brapi_get_samples(
  con = NULL,
  sampleDbId = "",
  observationUnitDbId = "",
  plateDbId = "",
  germplasmDbId = "",
  studyDbId = "",
  externalReferenceID = "",
  externalReferenceSource = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
sampleDbId	character; required: FALSE; the unique internal database identifier for a sample
observationUnitDbId	character; required: FALSE; the unique internal database identifier for an observation unit, where a sample was taken from.
plateDbId	character; required: FALSE; the unique internal database identifier for a plate of samples.
germplasmDbId	character; required: FALSE; the unique internal database identifier for a germplasm.
studyDbId	character; required: FALSE; The unique internal database study identifier to filter by.
externalReferenceID	character; required: FALSE; An external reference identifier. 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

Used to retrieve list of Samples from a Sample Tracking system based on some search criteria.

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-genotyping: brapi_get_callsets_callSetDbId_calls(), brapi_get_callsets_callSetDbId(), brapi_get_callsets(), brapi_get_calls(), brapi_get_maps_mapDbId_linkagegroups(), brapi_get_maps_mapDbId(), brapi_get_maps(), brapi_get_markerpositions(), brapi_get_references_referenceDbId_bases(), brapi_get_references_referenceDbId(), brapi_get_referencesets_referenceSetDbId(), brapi_get_referencesets(), brapi_get_references(), brapi_get_samples_sampleDbId(), brapi_get_search_calls_searchResultsDbId(), brapi_get_search_callsets_searchResultsDbId(), brapi_get_search_markerpositions_searchResultsDbId(), brapi_get_search_references_searchResultsDbId(), brapi_get_search_referencesets_searchResultsDbId(), brapi_get_search_samples_searchResultsDbId(), brapi_get_search_variants_searchResultsDbId(), brapi_get_search_variantsets_searchResultsDbId(), brapi_get_variants_variantDbId_calls(), brapi_get_variants_variantDbId(), brapi_get_variantsets_variantSetDbId_callsets(), brapi_get_variantsets_variantSetDbId_calls(), brapi_get_variantsets_variantSetDbId_variants(), brapi_get_variantsets_variantSetDbId(), brapi_get_variantsets(), brapi_get_variants(), brapi_get_vendor_orders_orderId_plates(), brapi_get_vendor_orders_orderId_results(), brapi_get_vendor_orders_orderId_status(), brapi_get_vendor_orders(), brapi_get_vendor_specifications(), brapi_post_samples(), brapi_post_search_callsets(), brapi_post_search_calls(), brapi_post_search_markerpositions(), brapi_post_search_referencesets(), brapi_post_search_references(), brapi_post_search_samples(), brapi_post_search_variantsets(), brapi_post_search_variants(), brapi_post_variantsets_extract(), brapi_put_samples_sampleDbId()

Other Samples: brapi_get_samples_sampleDbId(), brapi_get_search_samples_searchResultsDbId(), brapi_post_samples(), brapi_post_search_samples(), brapi_put_samples_sampleDbId()

Examples

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

## End(Not run)

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