brapi_post_search_variants: post /search/variants

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

post /search/variants

Description

Submit a search request for Variants

Usage

brapi_post_search_variants(
  con = NULL,
  callSetDbIds = "",
  start = as.integer(NA),
  end = as.integer(NA),
  referenceDbId = "",
  variantDbIds = "",
  variantSetDbIds = "",
  pageToken = "",
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
callSetDbIds	vector of type character; required: FALSE; The CallSet to search for specified as unique database callset identifier(s).; default: "", when using multiple values supply as c("value1", "value2").
start	integer; required: FALSE; The beginning of the window (0-based, inclusive) for which overlapping variants should be returned. 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 of the window (0-based, exclusive) for which overlapping variants should be returned.
referenceDbId	character; required: FALSE; Only return variants on this unique reference database identifier; default: "".
variantDbIds	vector of type character; required: FALSE; The unique Variant database identifier(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
variantSetDbIds	vector of type character; required: FALSE; The unique VariantSet database identifier(s) to search for; default: "", when using multiple values supply as c("value1", "value2").
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

Submit a search request for Variants. Function will return either the search results (Status 200 for an immediate response) or a searchResultsDbId (Status 202 for both a saved and an asynchronous search).

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_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_variantsets_extract(), brapi_put_samples_sampleDbId()

Other Variants: brapi_get_search_variants_searchResultsDbId(), brapi_get_variants_variantDbId_calls(), brapi_get_variants_variantDbId(), brapi_get_variants()

Examples

## Not run: 
con <- brapi_db()$testserver
con[["token"]] <- "YYYY"

# Immediate Response Example
brapi_post_search_variants(con = con, pageSize = 1000)

# Saved or Asynchronous Search Response Example
brapi_post_search_variants(con = con,
                           callSetDbIds = c("callset01",
                                            "callset02"),
                           start = 0,
                           end = 1000,
                           variantDbIds = c("variant01",
                                            "variant02"),
                           variantSetDbIds = "variantset1",
                           pageSize = 1000)

## End(Not run)

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