brapi_get_trials: get /trials

In mverouden/brapir-v2: Client to Access BrAPI Compliant Plant Breeding Databases

get /trials

Description

Get a filtered list of Trials

Usage

brapi_get_trials(
  con = NULL,
  active = NA,
  commonCropName = "",
  contactDbId = "",
  programDbId = "",
  locationDbId = "",
  searchDateRangeStart = "",
  searchDateRangeEnd = "",
  studyDbId = "",
  trialDbId = "",
  trialName = "",
  trialPUI = "",
  sortBy = "",
  sortOrder = "",
  externalReferenceID = "",
  externalReferenceSource = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
active	logical; required: FALSE; Filter active status true/false. Default: NA, other possible values: TRUE | FALSE
commonCropName	character; required: FALSE; Common name for the crop associated with this trial
contactDbId	character; required: FALSE; Contact entities associated with this trial
programDbId	character; required: FALSE; Program filter to only return trials associated with given program id.
locationDbId	character; required: FALSE; Filter by location
searchDateRangeStart	character; required: FALSE; The start of the overlapping search date range. searchDateRangeStart must be before searchDateRangeEnd.
searchDateRangeEnd	character; required: FALSE; The start of the overlapping search date range. searchDateRangeStart must be before searchDateRangeEnd. Return a Trial entity if any of the following cases are true: searchDateRangeStart is before trial.endDate AND searchDateRangeEnd is null searchDateRangeStart is before trial.endDate AND searchDateRangeEnd is after trial.startDate searchDateRangeEnd is after trial.startDate AND searchDateRangeStart is null searchDateRangeEnd is after trial.startDate AND searchDateRangeStart is before trial.endDate
studyDbId	character; required: FALSE; Filter by connected studyDbId
trialDbId	character; required: FALSE; Filter by trialDbId
trialName	character; required: FALSE; Filter by trial name
trialPUI	character; required: FALSE; Filter by trial PUI
sortBy	character; required: FALSE; Sort order. Name of the field to sort by.
sortOrder	character; required: FALSE; Sort order direction: asc/desc. Default: "", other possible values: "asc"|"ASC"|"desc"|"DESC"
externalReferenceID	character; required: FALSE; An external reference ID. Could be a simple string or a URI. (use with externalReferenceSource parameter)
externalReferenceSource	character; required: FALSE; An identifier for the source system or database of an external reference (use with externalReferenceID parameter)
page	integer; required: FALSE; Used to request a specific page of data to be returned. The page indexing starts at 0 (the first page is page = 0). Default is 0.
pageSize	integer; required: FALSE; The size of the pages to be returned. Default is 1000.

Details

Retrieve a filtered list of breeding Trials. A Trial is a collection of Studies

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-core: brapi_get_commoncropnames(), brapi_get_lists_listDbId(), brapi_get_lists(), brapi_get_locations_locationDbId(), brapi_get_locations(), brapi_get_people_personDbId(), brapi_get_people(), brapi_get_programs_programDbId(), brapi_get_programs(), brapi_get_search_lists_searchResultsDbId(), brapi_get_search_locations_searchResultsDbId(), brapi_get_search_people_searchResultsDbId(), brapi_get_search_programs_searchResultsDbId(), brapi_get_search_studies_searchResultsDbId(), brapi_get_search_trials_searchResultsDbId(), brapi_get_seasons_seasonDbId(), brapi_get_seasons(), brapi_get_serverinfo(), brapi_get_studies_studyDbId(), brapi_get_studies(), brapi_get_studytypes(), brapi_get_trials_trialDbId(), brapi_post_lists_listDbId_items(), brapi_post_lists(), brapi_post_locations(), brapi_post_people(), brapi_post_programs(), brapi_post_search_lists(), brapi_post_search_locations(), brapi_post_search_people(), brapi_post_search_programs(), brapi_post_search_studies(), brapi_post_search_trials(), brapi_post_seasons(), brapi_post_studies(), brapi_post_trials(), brapi_put_lists_listDbId(), brapi_put_locations_locationDbId(), brapi_put_people_personDbId(), brapi_put_programs_programDbId(), brapi_put_seasons_seasonDbId(), brapi_put_studies_studyDbId(), brapi_put_trials_trialDbId()

Other Trials: brapi_get_search_trials_searchResultsDbId(), brapi_get_trials_trialDbId(), brapi_post_search_trials(), brapi_post_trials(), brapi_put_trials_trialDbId()

Examples

## Not run: 
con <- brapi_db()$testserver
brapi_get_trials(con = con)

## End(Not run)

mverouden/brapir-v2 documentation built on April 22, 2022, 9:24 a.m.