set_qbms_config: Configure BMS server settings

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

Configure BMS server settings

Description

Set the connection configuration of the BMS server

Usage

set_qbms_config(
  url = "http://localhost/ibpworkbench/controller/auth/login",
  path = NULL,
  page_size = 1000,
  time_out = 120,
  no_auth = FALSE,
  engine = "bms",
  brapi_ver = "v1",
  verbose = TRUE
)

Arguments

url	URL of the BMS login page (default is "http://localhost/ibpworkbench/")
path	BMS API path (default is NULL)
page_size	Page size (default is 1000)
time_out	Number of seconds to wait for a response until giving up (default is 10)
no_auth	TRUE if the server doesn't require authentication/login (default is FALSE)
engine	Backend database (bms default, breedbase, gigwa, ebs)
brapi_ver	BrAPI version (v1 or v2)
verbose	Logical indicating if progress bar will display on the console when retrieve data from API (TRUE by default).

Value

no return value

Author(s)

Khaled Al-Shamaa, [e-mail]

Examples

set_qbms_config("https://bmsdev-brapi.ibp.services/ibpworkbench")

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