brapi_post_search_references: post /search/references

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

post /search/references

Description

Submit a search request for References

Usage

brapi_post_search_references(
  con = NULL,
  accessions = "",
  isDerived = NA,
  maxLength = as.integer(NA),
  md5checksums = "",
  minLength = as.integer(NA),
  page = 0,
  pageSize = 1000,
  referenceDbIds = "",
  referenceSetDbIds = ""
)

Arguments

con	list; required: TRUE; BrAPI connection object
accessions	vector of type character; required: FALSE; If specified, return the references for which the accession matches this string (case- sensitive, exact match); default: "", when using multiple values supply as c("value1", "value2").
isDerived	logical; required: FALSE; A sequence X is said to be derived from source sequence Y, if X and Y are of the same length and the per-base sequence divergence at A/C/G/T bases is sufficiently small. Two sequences derived from the same official sequence share the same coordinates and annotations, and can be replaced with the official sequence for certain use cases. If the reference is derived (TRUE) from a source sequence or not (FALSE). If unspecified (NA), both will be displayed.
maxLength	integer; required: FALSE; The maximum length of the reference sequences to be retrieved.
md5checksums	vector of type character; required: FALSE; If specified, return the references for which the md5checksum matches this string (case-sensitive, exact match); default: "", when using multiple values supply as c("value1", "value2").
minLength	integer; required: FALSE; The minimum length of the reference sequences to be retrieved.
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.
referenceDbIds	vector of type character; required: FALSE; The unique database identifier(s) of a reference or references to search; default: "", when using multiple values supply as c("value1", "value2").
referenceSetDbIds	vector of type character; required: FALSE; The unique database identifier(s) of a reference set or reference sets to search.; default: "", when using multiple values supply as c("value1 ", "value2").

Details

Submit a search request for References. 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_samples(), brapi_post_search_variantsets(), brapi_post_search_variants(), brapi_post_variantsets_extract(), brapi_put_samples_sampleDbId()

Other References: brapi_get_references_referenceDbId_bases(), brapi_get_references_referenceDbId(), brapi_get_references(), brapi_get_search_references_searchResultsDbId()

Examples

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

# Immediate Response Example
brapi_post_search_references(con = con,
                             page = 0,
                             pageSize = 1000)

# Saved or Asynchronous Search Response Example
brapi_post_search_references(con = con,
                             accessions = c("A0000001",
                                            "A0000002"),
                             page = 0,
                             pageSize = 1000,
                             referenceDbIds = c("reference1",
                                                "reference2"),
                             referenceSetDbIds = c("reference_set1",
                                                   "reference_set2"))

## End(Not run)

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