ba_trials.Rd
lists trials available on a brapi server
ba_trials(con = NULL, programDbId = "", locationDbId = "", active = TRUE, sortBy = "", sortOrder = "", page = 0, pageSize = 1000, rclass = "tibble")
con | list, brapi connection object |
---|---|
programDbId | character; default: 'any'; otherwise an identifier |
locationDbId | character; default: 'any'; otherwise an identifier |
active | logical; default: 'TRUE'; otherwise TRUE or FALSE |
sortBy | character; default: 'none'; otherwise a name from the first level entry names of the return object. |
sortOrder | character; default: 'asc'; otherwise 'desc' |
page | integer; default 0 |
pageSize | integer; default 1000 |
rclass | character; default: "tibble" possible other values: "json"/"list"/"data.frame" |
rclass as defined
Tested against: sweetpotatobase, BMS
Other trials: ba_trials_details
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_search
,
ba_studies_seasons
,
ba_studies_studytypes
,
ba_studies_table_save
,
ba_studies_table
,
ba_trials_details
if (interactive()) { library(brapi) # Need to connect to a database with genetic data # con <- ba_db()$xxxxx # ba_trials(con = con, ...) }