ba_phenotypes_search: ba_phenotypes_search

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

Description

Retrieve a list of observation units with the observed Phenotypes using a GET method.

Usage

ba_phenotypes_search(con = NULL, germplasmDbId = "",
  observationVariableDbId = "", studyDbId = "", locationDbId = "",
  trialDbId = "", programDbId = "", seasonDbId = "",
  observationLevel = "", observationTimeStampRangeStart = "",
  observationTimeStampRangeEnd = "", pageSize = 1000, page = 0,
  rclass = c("tibble", "data.frame", "list", "json"))

Arguments

con	list, brapi connection object
germplasmDbId	character, search for observation units where the specified germplasm has been used/tested; e.g. "CML123"; default: ""
observationVariableDbId	character, search for observation units where the specified observation variable, supplied as a character string of the internal observation variable database identifier e.g. "CO-PH-123", has been measured; default: ""
studyDbId	character, search for observation units by an internal study database identifier e.g. "1001"; default: ""
locationDbId	character, search for observation units with the observed Phenotypes by an internal location database identifier; default: ""
trialDbId	character, search for observation units with the observed Phenotypes by an internal trial database identifier; default: ""
programDbId	character, search for observation units with the observed Phenotypes by an internal program database identifier; default: ""
seasonDbId	character, search for observation units with the observed Phenotypes by an internal season database identifier; default: ""
observationLevel	character, search for observation units with the observed Phenotypes by specifying observation level e.g. "plant"/"plot"; default: ""
observationTimeStampRangeStart	chararcter, specifying the time stamp range start from which to search for the observation units with the observed Phenotypes; default: ""
observationTimeStampRangeEnd	character, specifying the time stamp range end to which to search for the observation units with the observed Phenotypes; 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: "json"/"list"/"data.frame"

Value

An object of class as defined by rclass containing the observation units with the observed Phenotypes.

Note

Tested against: test-server

BrAPI Version: 1.2

BrAPI Status: active

Author(s)

Reinhard Simon, Maikel Verouden

References

github

See Also

Other studies: 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_search, ba_studies_seasons, ba_studies_studytypes, ba_studies_table_save, ba_studies_table

Other phenotyping: 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, ba_trials

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