ba_studies_search_post: ba_studies_search_post

In CIP-RIU/brapi: Client to Access Breeding Databases Using BrAPI

Description

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

Usage

ba_studies_search_post(con = NULL, studyDbIds = "", trialDbIds = "",
  programDbIds = "", locationDbIds = "", seasonDbId = "",
  studyType = "", studyNames = "", studyLocations = "",
  programNames = "", commonCropName = "", germplasmDbIds = "",
  observationVariableDbIds = "", active = NA, sortBy = "",
  sortOrder = "", pageSize = 1000, page = 0, rclass = c("tibble",
  "data.frame", "list", "json"))

Arguments

con	list, brapi connection object
studyDbIds	character vector, search for study details of specified studies, supplied as a comma separated character vector of internal study database identifiers e.g. c("35", "345"); default: ""
trialDbIds	character vector, search for studies and details of specified trials, supplied as a comma separated character vector of internal trial database identifiers e.g. c("7", "8"); default: ""
programDbIds	character vector, search for studies and details of specified programs, supplied as a comma separated character vector of internal program database identifiers e.g. c("27", "58"); default: ""
locationDbIds	character vector, search for studies and details of specified locations, supplied as a comma separated character vector of internal location database identifiers e.g. c("23", "33"); default:""
seasonDbId	character vector, search for studies and details by specified seasons, supplied as a comma separated character vector of internal season database identifiers e.g. c("237", "238"); default: ""
studyType	character; search for studies and details based on a study type e.g. "Nursery", or "Yield Trial"; default: ""
studyNames	character vector, search for studies by study names, supplied as a comma separated character vector of study names e.g. c("Study A", "Study B"); default: ""
studyLocations	character vector; search for studies by study locations, supplied as a comma separated character vector of study locations e.g. c("Kenya", "Zimbabwe"); default: ""
programNames	character vector; search for studies by program names, supplied as a comma separated character vector of program names e.g. c("Test Program", "Program2"); default: ""
commonCropName	character, search for studies by a common crop name e.g. "wheat"; 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 e.g. "studyDbId"; 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, 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, ba_studies_seasons, ba_studies_studytypes, ba_studies_table_save, ba_studies_table, ba_trials_details, ba_trials

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_studies_search_post(con)
}

CIP-RIU/brapi documentation built on Oct. 17, 2019, 2 p.m.