Create BrAPI Connection (with database URL) — createBrAPIConnection • BrAPI

Create a BrAPI connection to the specified host / URL of the database. This can be used to create a BrAPI connection to any BrAPI-compliant database.

Usage

createBrAPIConnection(
  host = NULL,
  protocol = "https",
  path = "/brapi/",
  version = "v2",
  params = list(),
  is_breedbase = FALSE
)

Arguments

host: The BrAPI server hostname
protocol: (optional) the HTTP protocol (either 'http' or 'https') (DEFAULT: https)
path: (optional) the base path to the BrAPI endpoints (without the version) (DEFAULT: /brapi/)
version: (optional) the BrAPI version to use (DEFAULT: v2)
params: (optional) additional query params (added as a named list) that are added to each request (DEFAULT: none)
is_breedbase: (optional) set to TRUE if the connection is to a breedbase instance (DEFAULT: FALSE)

Value

BrAPIConnection

Examples

wheat <- createBrAPIConnection("wheat.triticeaetoolbox.org", is_breedbase=TRUE)
oatv1 <- createBrAPIConnection("oat.triticeaetoolbox.org", version="v1", is_breedbase=TRUE)
grin <- createBrAPIConnection("npgsweb.ars-grin.gov", path="/gringlobal/brapi/", params=list(commoncropname = "WHEAT"))