set_study: Set the current active study by location name

View source: R/qbms.R

set_studyR Documentation

Set the current active study by location name

Description

This function will update the current active study in the internal state object using the studyDbId retrieved from BMS which is associated to the given study_name parameter.

Usage

set_study(study_name)

Arguments

study_name

the name of the study

Value

no return value

Author(s)

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

See Also

login_bms, set_crop, set_program, set_trial, list_studies

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

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