get_study_info: Get the details/metadata of the current active study

In khaled-alshamaa/QBMS: Query the Breeding Management System(s)

Get the details/metadata of the current active study

Description

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

Usage

get_study_info()

Value

a data frame of the study details/metadata

Author(s)

Khaled Al-Shamaa, [e-mail]

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 general information of the selected environment/location
info <- get_study_info()
}

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