brapi_get_variants_variantDbId_calls: get /variants/{variantDbId}/calls

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

get /variants/{variantDbId}/calls

Description

Gets a list of Calls associated with a Variant.

Usage

brapi_get_variants_variantDbId_calls(
  con = NULL,
  variantDbId = "",
  expandHomozygotes = NA,
  unknownString = "",
  sepPhased = "",
  sepUnphased = "",
  pageToken = "",
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
variantDbId	character; required: TRUE; The unique database identifier of the Variant to be retrieved.
expandHomozygotes	logical; required: FALSE; Should homozygotes be expanded (TRUE) or collapsed into a single occurrence (FALSE); default: NA , other possible values: TRUE | FALSE
unknownString	character; required: FALSE; The string to use as a representation for missing data.
sepPhased	character; required: FALSE; The string to use as a separator for phased allele calls.
sepUnphased	character; required: FALSE; The string to use as a separator for unphased allele calls.
pageToken	character; required: FALSE; Used to request a specific page of data to be returned. Tokenized pages are for large data sets, which can not be efficiently broken into indexed pages. Use the nextPageToken and prevPageToken from a prior response to construct a query and move to the next or previous page respectively.
pageSize	integer; required: FALSE; The size of the pages to be returned. Default is 1000.

Details

The variant calls for this particular variant. Each one represents the determination of genotype with respect to this variant. Calls in this array are implicitly associated with this Variant.

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_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(), 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 Variants: brapi_get_search_variants_searchResultsDbId(), brapi_get_variants_variantDbId(), brapi_get_variants(), brapi_post_search_variants()

Examples

## Not run: 
con <- brapi_db()$testserver
brapi_get_variants_variantDbId_calls(
  con = con,
  variantDbId = "variant01",
  pageSize = 1000)

## End(Not run)

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