Description Usage Arguments Details Value Note Author(s) References See Also Examples
View source: R/ba_studies_observationunits.R
Retrieve all the observation units within a specific study.
1 2 3 | ba_studies_observationunits(con = NULL, studyDbId = "",
observationLevel = c("any", "plot", "plant"), pageSize = 1000,
page = 0, rclass = c("tibble", "data.frame", "list", "json"))
|
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" |
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.
An object of class as defined by rclass containing the observation units for a requested study.
Tested against: test-server, sweetpotatobase
BrAPI Version: 1.0, 1.1, 1.2
BrAPI Status: active
R Brapi Status: incomplete response parsing
Reinhard Simon
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
1 2 3 4 5 6 7 | if (interactive()) {
library(brapi)
con <- ba_db()$testserver
ba_studies_observationunits(con, studyDbId = "1001")
}
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.