ba_markers_search_post: ba_markers_search_post

In c5sire/brapi: Client to Access Breeding Databases Using BrAPI

Description

Search for markers on a brapi server via a POST method.

Usage

ba_markers_search_post(con = NULL, markerDbIds = "", name = "",
  matchMethod = "", includeSynonyms = NA, type = "",
  pageSize = 1000, page = 0, rclass = c("tibble", "data.frame",
  "list", "json"))

Arguments

con	list, brapi connection object
markerDbIds	character vector, search for specific markers by internal database identifiers, supplied as a comma separated character vector of internal marker database identifiers e.g. c("1185","1186"); default: ""
name	character, search for markers by a search pattern of a marker name or synonym e.g. "11_1002", "11_1 default: ""
matchMethod	character, search for markers using a match method with as possible values "case_insensitive", "exact" (which is case sensitive), and "wildcard" (which is case insensitive and uses both "*" and " for one character matching); default: "", which results in "exact"
includeSynonyms	logical, search for markers including synonyms, specified as TRUE, or without, specified as FALSE; default: NA, possible other values: TRUE/FALSE
type	character, search for a specific type of marker, e.g. "SNP"; default: ""
pageSize	integer, items per page to be returned; default: 1000
page	integer, the requested page to be returned; default: 0 (1st page)
rclass	character, class of the object to be returned; default: "tibble" , possible other values: "json"/"list"/"vector"/"data.frame"

Value

An object of class as defined by rclass containing the markers fulfilling the search criteria.

Note

Tested against: test-server

BrAPI Version: 1.1, 1.2

BrAPI Status: active

Author(s)

Reinhard Simon, Maikel Verouden

References

github

See Also

Other markers: ba_markers_details, ba_markers_search

Other genotyping: ba_genomemaps_data_range, ba_genomemaps_data, ba_genomemaps_details, ba_genomemaps, ba_germplasm_attributes, ba_germplasm_markerprofiles, ba_germplasm_search_post, ba_germplasm_search, ba_germplasmattributes_attributes, ba_germplasmattributes_categories, ba_germplasmattributes_details, ba_markerprofiles_allelematrices_details, ba_markerprofiles_allelematrices_search_post, ba_markerprofiles_allelematrices_search, ba_markerprofiles_allelematrix_search, ba_markerprofiles_details, ba_markerprofiles_search, ba_markers_details, ba_markers_search

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_markers_search_post(con)
}

c5sire/brapi documentation built on Oct. 17, 2019, 11:45 a.m.