get_study_data: Get the observations data of the current active study

View source: R/qbms.R

get_study_dataR Documentation

Get the observations data of the current active study

Description

This function will retrieve the observations data of the current active study as configured in the internal state object using 'set_study()' function.

Usage

get_study_data()

Value

a data frame of the study observations data

Author(s)

Khaled Al-Shamaa, k.el-shamaa@cgiar.org

See Also

login_bms, set_crop, set_program, set_trial, set_study

Examples

if(interactive()) {
# config your BMS connection
set_qbms_config("https://bmsdev-brapi.ibp.services/ibpworkbench")

# login using your BMS account (interactive mode)
# you can pass BMS username and password as parameters (batch mode)
login_bms()

set_crop("maize")

# select a breeding program by name
set_program("MC Maize")

# select a specific study/trial by name
set_trial("2018 PVT")

# select a specific environment/location dataset
set_study("2018 PVT Environment Number 1")

# retrieve the data of the selected environment/location
data <- get_study_data()
}

khaled-alshamaa/QBMS documentation built on Jan. 27, 2024, 6:40 a.m.