brapi_get_studies: get /studies

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

get /studies

Description

Get a filtered list of Studies

Usage

brapi_get_studies(
  con = NULL,
  commonCropName = "",
  studyType = "",
  programDbId = "",
  locationDbId = "",
  seasonDbId = "",
  trialDbId = "",
  studyDbId = "",
  studyName = "",
  studyCode = "",
  studyPUI = "",
  germplasmDbId = "",
  observationVariableDbId = "",
  active = NA,
  sortBy = "",
  sortOrder = "",
  externalReferenceID = "",
  externalReferenceSource = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
commonCropName	character; required: FALSE; Common name for the crop associated with this study
studyType	character; required: FALSE; Filter based on study type unique identifier
programDbId	character; required: FALSE; Program filter to only return studies associated with given program id.
locationDbId	character; required: FALSE; Filter by location
seasonDbId	character; required: FALSE; Filter by season or year
trialDbId	character; required: FALSE; Filter by trial
studyDbId	character; required: FALSE; Filter by study DbId
studyName	character; required: FALSE; Filter by study name
studyCode	character; required: FALSE; Filter by study code
studyPUI	character; required: FALSE; Filter by study PUI
germplasmDbId	character; required: FALSE; Filter by germplasm DbId
observationVariableDbId	character; required: FALSE; Filter by observation variable DbId
active	logical; required: FALSE; Filter active status true/false. Default: NA, other possible values: TRUE | FALSE
sortBy	character; required: FALSE; Name of the field to sort by.
sortOrder	character; required: FALSE; Sort order direction. Ascending/Descending.; 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

Get list of studies, where StartDate and endDate should be ISO-8601 format for dates.

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_studytypes(), brapi_get_trials_trialDbId(), brapi_get_trials(), 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 Studies: brapi_get_search_studies_searchResultsDbId(), brapi_get_studies_studyDbId(), brapi_get_studytypes(), brapi_post_search_studies(), brapi_post_studies(), brapi_put_studies_studyDbId()

Examples

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

## End(Not run)

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