ba_studies_search

lists trials available on a brapi server

ba_studies_search(con = NULL, studyType = "", programDbId = "",
  locationDbId = "", seasonDbId = "", germplasmDbIds = "",
  observationVariableDbIds = "", active = "", sortBy = "",
  sortOrder = "", page = 0, pageSize = 1000, verb = "GET",
  rclass = "tibble")

Arguments

con	brapi connection object
studyType	character; default: ''
programDbId	character; default: ''
locationDbId	character; default: ''
seasonDbId	character; default: ''
germplasmDbIds	character; default: ''
observationVariableDbIds	character; default: ''
active	character; default: ''
sortBy	character; default: ''
sortOrder	character; default: ''
page	integer; default: 1000
pageSize	integer; default: 0
verb	character; default: 'GET' (or 'POST')
rclass	character; default: tibble

Value

rclass as defined

Note

This call must have set a specific identifier. The default is an empty string. If not changed to an identifier present in the database this will result in an error.

Tested against: sweetpotatobase

References

github

See also

Other studies: ba_studies_details, ba_studies_layout, ba_studies_observationlevels, ba_studies_observations, ba_studies_observationunits, ba_studies_observationvariables, ba_studies_seasons, ba_studies_studytypes, ba_studies_table_save, ba_studies_table

Other phenotyping: ba_samples_save, ba_samples, ba_studies_details, ba_studies_layout, ba_studies_observationlevels, ba_studies_observations, ba_studies_observationunits_save, ba_studies_observationunits, ba_studies_observationvariables, ba_studies_seasons, ba_studies_studytypes, ba_studies_table_save, ba_studies_table, ba_trials_details, ba_trials

Examples

if (interactive()) {
  library(brapi)

  # Need to connect to a database with genetic data

  # con <- ba_db()$xxxxx

  # ba_studies_search(con = con, ...)
}