ba_studies_details: ba_studies_details

Description Usage Arguments Details Value Note Author(s) References See Also Examples

View source: R/ba_studies_details.R

Description

Gets study details given an internal database identifier.

Usage

1
2
ba_studies_details(con = NULL, studyDbId = "", 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 study details are to be retrieved e.g. "1001"; REQUIRED ARGUMENT with default: ""

rclass

character, class of the object to be returned; default: "tibble" , possible other values: "data.frame"/"list"/"json"

Details

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

Value

An object of class as defined by rclass containing the study details.

Note

Tested against: sweetpotatobase, 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_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_phenotypes_search, ba_samples_save, ba_samples_search_post, ba_samples_search, ba_samples, 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

Examples

1
2
3
4
5
6
7
8
if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_studies_details(con, "1001")

}

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