ba_studies_observationunits: ba_studies_observationunits

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

Description

Retrieve all the observation units within a specific study.

Usage

ba_studies_observationunits(con = NULL, studyDbId = "",
  observationLevel = c("any", "plot", "plant"), pageSize = 1000,
  page = 0, rclass = c("tibble", "data.frame", "list", "json"))

Arguments

con	list, brapi connection object
studyDbId	character, the internal database identifier for a study of which the observation units are to be retrieved e.g. "1001"; REQUIRED ARGUMENT with default: ""
observationLevel	character, specifying the granularity level of observation units, where either "plotNumber" or "plantNumber" fields will be relavant depending on whether granularity is specified as "plot" or "plant" respectively; default: "any", other possible value: "plot"/"plant"
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: "data.frame"/"list"/"json"

Details

This call must have set a specific identifier. The default is an empty string. If not changed to an identifier present in the database this will result in an error.

Value

An object of class as defined by rclass containing the observation units for a requested study.

Note

Tested against: test-server, sweetpotatobase

BrAPI Version: 1.0, 1.1, 1.2

BrAPI Status: active

R Brapi Status: incomplete response parsing

Author(s)

Reinhard Simon

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_observationvariables, ba_studies_search_post, 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_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

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_studies_observationunits(con, studyDbId = "1001")
}

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