ba_trials: ba_trials

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

Description

Lists trial summaries available on a brapi server

Usage

ba_trials(con = NULL, programDbId = "", locationDbId = "",
  active = NA, sortBy = "", sortOrder = "", pageSize = 1000,
  page = 0, rclass = c("tibble", "data.frame", "list", "json"))

Arguments

con	list, brapi connection object
programDbId	character; program filter to only return trials associated with given program database identifier; default: ""
locationDbId	character, location filter to only return trails associated with given location databas identifier; default: ""
active	logical; filter active status; default: NA (shows both active and inactive), other possible values TRUE (show active)/FALSE (show inactive)
sortBy	character; name of the field to sort by; default: ""
sortOrder	character; sort order direction; default: "", possible values "asc"/"desc"
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"/"data.frame"

Value

An object of class as defined by rclass containing tiral summaries.

Note

Tested against: BMS, sweetpotatobase, test-server

BrAPI Version: 1.0, 1.1, 1.2

BrAPI Status: active

Author(s)

Reinhard Simon, Maikel Verouden

References

github

See Also

Other trials: ba_trials_details

Other phenotyping: ba_phenotypes_search, ba_samples_save, ba_samples_search_post, ba_samples_search, 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_post, ba_studies_search, ba_studies_seasons, ba_studies_studytypes, ba_studies_table_save, ba_studies_table, ba_trials_details

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_trials(con)
}

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