list_studies: Get the list of studies in the current active trial

View source: R/qbms.R

list_studiesR Documentation

Get the list of studies in the current active trial

Description

This function will retrieve the studies list from the current active trial as configured in the internal state object using 'set_trial()' function.

Usage

list_studies()

Value

a list of study and location names

Author(s)

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

See Also

login_bms, set_crop, set_program, set_trial

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")

# list all environments/locations information in the selected study/trial
list_studies()
}

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