brapi_get_references_referenceDbId_bases: get /references/{referenceDbId}/bases

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

get /references/{referenceDbId}/bases

Description

Lists Reference bases by database identifier and optional range.

Usage

brapi_get_references_referenceDbId_bases(
  con = NULL,
  referenceDbId = "",
  start = as.integer(NA),
  end = as.integer(NA),
  pageToken = ""
)

Arguments

con	list; required: TRUE; BrAPI connection object
referenceDbId	character; required: TRUE; The unique identifier of the Reference to be retrieved.
start	integer; required: FALSE; The start position (0-based) of this query. Defaults to 0. Genomic positions are non-negative integers less than reference length. Requests spanning the join of circular genomes are represented as two requests one on each side of the join (position 0).
end	integer; required: FALSE; The end position (0-based, exclusive) of this query. Defaults to the length of this Reference.
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.

Details

Lists Reference bases by ID and optional range.

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(), 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_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 References: brapi_get_references_referenceDbId(), brapi_get_references(), brapi_get_search_references_searchResultsDbId(), brapi_post_search_references()

Examples

## Not run: 
con <- brapi_db()$testserver
brapi_get_references_referenceDbId_bases(con = con,
                                         referenceDbId = "reference1")

## End(Not run)

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