ba_programs: ba_programs

In CIP-RIU/brapi: Client to Access Breeding Databases Using BrAPI

Description

Retrieve a list of the breeding programs.

Usage

ba_programs(con = NULL, programName = "", abbreviation = "",
  commonCropName = "", pageSize = 1000, page = 0,
  rclass = c("tibble", "data.frame", "list", "json"))

Arguments

con	list, brapi connection object
programName	character, filter programs by program name; default: ""
abbreviation	character, filter programs by program abbreviation; default: ""
commonCropName	character, filter programs by a common crop name; default: ""
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

Filtering by commonCropName has not be tested yet, because none of the databases support this feature yet (not even the test-server)!

Value

An object of class as defined by rclass containing the breeding programs.

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

See Also

Other brapicore: ba_calls, ba_commoncropnames, ba_crops, ba_germplasm_details_study, ba_germplasm_details, ba_germplasm_pedigree, ba_germplasm_progeny, ba_germplasm_search_post, ba_germplasm_search, ba_observationvariables_datatypes, ba_observationvariables_details, ba_observationvariables_ontologies, ba_observationvariables, ba_phenotypes_search_post, ba_programs_search_post, ba_studies_germplasm_details, ba_traits_details, ba_traits

Examples

if (interactive()) {
  library(brapi)

  con <- ba_db()$testserver

  ba_programs(con)
}

CIP-RIU/brapi documentation built on Oct. 17, 2019, 2 p.m.