get_study_info {QBMS}

Get the Details/Metadata of the Current Active Study

Description

Retrieves 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()) {
  # Configure your server connection
  set_qbms_config("https://bms.icarda.org/ibpworkbench")

  # Login using your account (interactive mode)
  # You can pass your username and password as parameters (batch mode)
  login_bms()

  # Select a crop by name
  set_crop("wheat")

  # Select a breeding program by name
  set_program("Wheat International Nurseries")

  # Select a specific study/trial by name
  set_trial("IDYT39")

  # Select a specific environment/location dataset
  set_study("IDYT39 Environment Number 9")

  # Retrieve the general information of the selected environment/location
  info <- get_study_info()
}