ba_locations: ba_locations

In c5sire/brapi: Client to Access Breeding Databases Using BrAPI

Description

Lists locations available on a brapi server.

Usage

ba_locations(con = NULL, locationType = "", pageSize = 1000,
  page = 0, rclass = c("tibble", "data.frame", "list", "json"))

Arguments

con	list, brapi connection object
locationType	character, filter by a specified location type.
pageSize	integer, items per page to be returned; default: 1000
page	integer, the requested page to be returned; default: 0 (1st page)
rclass	character, class of the object to be returned; default: "tibble" , possible other values: "json"/"list"/"data.frame"

Details

All standard attributes are always listed. However, attributes in the additionalInfo only when at least one record has data.

Value

An object of class as defined by rclass containing locations.

Note

Tested against: BMS, sweetpotatobase, test-server

BrAPI Version: 1.0, 1.1, 1.2

BrAPI Status: active

Author(s)

Reinhard Simon, Maikel Verouden

References

github

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_locations(con)


}

c5sire/brapi documentation built on Oct. 17, 2019, 11:45 a.m.