ba_markerprofiles_allelematrices_details: ba_markerprofiles_allelematrices_details

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

Description

Retrieve available allelematrices details for a specific study.

Usage

ba_markerprofiles_allelematrices_details(con = NULL, studyDbId = "",
  pageSize = 10000, page = 0, rclass = c("tibble", "data.frame",
  "list", "json"))

Arguments

con	list, brapi connection object
studyDbId	character, the internal database identifier for a study of which the available allelematrices details are to be retrieved e.g. "1001"; REQUIRED ARGUMENT with 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: "data.frame"/"list"/"json"

Value

An object of class as defined by rclass containing the allelematrices details of the requested study internal database indentifier.

Note

The handling of long-running responses via asynch status messages not yet implemented.

Tested against: test-server

BrAPI Version: 1.0, 1.1, 1.2

BrAPI Status: active

Author(s)

Reinhard Simon, Maikel Verouden

References

github

See Also

Other markerprofiles: ba_markerprofiles_allelematrices_search_post, ba_markerprofiles_allelematrices_search, ba_markerprofiles_allelematrix_search, ba_markerprofiles_details, ba_markerprofiles_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_search_post, ba_markerprofiles_allelematrices_search, ba_markerprofiles_allelematrix_search, ba_markerprofiles_details, ba_markerprofiles_search, ba_markers_details, ba_markers_search_post, ba_markers_search

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_markerprofiles_allelematrices_details(con = con, studyDbId = "1001")
}

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