ba_observationvariables_search_post: ba_observationvariables_search_post

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

Description

Search for observation variables on a brapi server via a POST method.

Usage

ba_observationvariables_search_post(con = NULL, datatypes = "",
  methodDbIds = "", names = "", observationVariableDbIds = "",
  ontologyXrefs = "", ontologyDbIds = "", scaleDbIds = "",
  traitClasses = "", pageSize = 1000, page = 0,
  rclass = c("tibble", "data.frame", "list", "json"))

Arguments

con	list, brapi connection object
datatypes	character vector, filter the search results by a list of scale data types, supplied as a comma separated character vector e.g. c("numeric"); default: ""
methodDbIds	character vector, filter the search results by a list of methods, supplied as a comma separated character vector of internal program database identifiers e.g. c("method-1", "method-2"); default: ""
names	character vector, search for observation variables by human readable observation variable names, supplied as a comma separated character vector e.g. c("caro_spectro"); default: ""
observationVariableDbIds	character vector, filter search results of observation variables by specified observation variable internal database identifiers, supplied as a comma separated character vector e.g. c("obs-variable-id1", "obs-variable-id1"); default: ""
ontologyXrefs	character vector, filter search results of observation variables using ontology cross references, supplied as a comma separated character vector e.g. c("CO:123", "CO:456"); default: ""
ontologyDbIds	character vector, filter search results of observation variables by ontology internal database identifiers, supplied as a comma separated character vector e.g. c(" CO_334:0100632"); default: ""
scaleDbIds	chararcter vector, filter search results of observation variables by specified scale internal database identifiers , supplied as a comma separated character vector e.g. c(" scale-1", "scale-2"); default: ""
traitClasses	character vector, filter search results of observation variables by trait classes, supplied as a comma separated character vector e.g. c("Phenological", "Physiological"); 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 variables 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

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_observationvariables_search_post(con)

}

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