ba_studies_search: ba_studies_search

Description Usage Arguments Value Note Author(s) References See Also

View source: R/ba_studies_search.R

Description

Search for study details on a brapi server via a GET method.

Usage

1
2
3
4
5
6
ba_studies_search(con = NULL, studyDbId = "", trialDbId = "",
  programDbId = "", commonCropName = "", locationDbId = "",
  seasonDbId = "", studyType = "", germplasmDbIds = "",
  observationVariableDbIds = "", active = NA, sortBy = "",
  sortOrder = "", pageSize = 1000, page = 0, rclass = c("tibble",
  "data.frame", "list", "json"))

Arguments

con

list, brapi connection object

studyDbId

character, search for study details by an internal study database identifier; default: ""

trialDbId

character, search for studies by an internal trial database identifier; default: ""

programDbId

character, search studies by an internal program database identifier; default: ""

commonCropName

character, search for studies by a common crop name; default: ""

locationDbId

character, search for studies by an internal location database identifier; default: ""

seasonDbId

character, search for studies by an internal season database identifier; default: ""

studyType

character; search for studies based on a study type e.g. "Nursery", "Trial" or "Genotype"; default: ""

germplasmDbIds

character vector; search for studies where specified germplasms, supplied as a comma separated character vector of internal gerplasm database identifiers e.g. c("CML123","CWL123"), have been used/tested; default: ""

observationVariableDbIds

character vector; search for studies where specified observation variables, supplied as a comma separated character vector of internal observation variable database identifiers e.g. c("CO-PH-123:,"Var-123"), have been measured; default: ""

active

logical; search studies by active status (by default both active and inactive studies are shown); default: NA, 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 the studies and details fulfilling the search criteria.

Note

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 studies: ba_phenotypes_search, ba_studies_details, ba_studies_germplasm_details, ba_studies_layout, ba_studies_observationlevels, ba_studies_observations, ba_studies_observationunits, ba_studies_observationvariables, ba_studies_search_post, ba_studies_seasons, ba_studies_studytypes, ba_studies_table_save, ba_studies_table

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_seasons, ba_studies_studytypes, ba_studies_table_save, ba_studies_table, ba_trials_details, ba_trials


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