set_qbms_config {QBMS} | R Documentation |
Configure BMS Server Settings
Description
Configures the BMS server connection settings, including URL, API path, page size, and timeout. This function allows you to set up the connection for different server backends like BMS, Gigwa, EBS, and Breedbase, and choose the appropriate BrAPI version.
Usage
set_qbms_config(
url = "http://localhost",
path = NULL,
page_size = 1000,
time_out = 120,
no_auth = FALSE,
engine = "bms",
brapi_ver = "v1",
verbose = TRUE
)
Arguments
url |
The URL of the BMS login page or API base (default is "http://localhost"). |
path |
The API path to use (default is NULL, which sets a path based on the engine). |
page_size |
The number of records per page when making API calls (default is 1000). |
time_out |
The maximum number of seconds to wait for a response (default is 120). |
no_auth |
Logical, whether the server requires authentication (default is FALSE). |
engine |
The backend system (default is "bms"). Options include "bms", "gigwa", "breedbase", "ebs". |
brapi_ver |
The version of BrAPI to use, either "v1" or "v2" (default is "v1"). |
verbose |
Logical, indicating whether to display progress information when making API calls (default is TRUE). |
Value
No return value.
Author(s)
Khaled Al-Shamaa, k.el-shamaa@cgiar.org
Examples
set_qbms_config("https://bms.icarda.org/ibpworkbench")