brapi_get_samples_sampleDbId: get /samples/{sampleDbId}

View source: R/brapi_get_samples_sampleDbId.R

brapi_get_samples_sampleDbIdR Documentation

get /samples/{sampleDbId}

Description

Get the details of a specific Sample

Usage

brapi_get_samples_sampleDbId(con = NULL, sampleDbId = "")

Arguments

con

list; required: TRUE; BrAPI connection object

sampleDbId

character; required: TRUE; the unique internal database identifier for a sample.

Details

Used to retrieve the details of a single Sample from a Sample Tracking system.

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(), 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(), 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_sampleDbId(con = con,
                             sampleDbId = "sample1")

## End(Not run)


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