brapi_get_observations: get /observations

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

get /observations

Description

Get a filtered set of Observations

Usage

brapi_get_observations(
  con = NULL,
  observationDbId = "",
  observationUnitDbId = "",
  germplasmDbId = "",
  observationVariableDbId = "",
  studyDbId = "",
  locationDbId = "",
  trialDbId = "",
  programDbId = "",
  seasonDbId = "",
  observationUnitLevelName = "",
  observationUnitLevelOrder = "",
  observationUnitLevelCode = "",
  observationTimeStampRangeStart = "",
  observationTimeStampRangeEnd = "",
  externalReferenceID = "",
  externalReferenceSource = "",
  page = 0,
  pageSize = 1000
)

Arguments

con	list; required: TRUE; BrAPI connection object
observationDbId	character; required: FALSE; Unique observation identifier to filter on.
observationUnitDbId	character; required: FALSE; Unique observation unit database identifier to filter on.
germplasmDbId	character; required: FALSE; Unique germplasm (accession) identifier to filter on
observationVariableDbId	character; required: FALSE; Unique observation variable identifier to filter on.
studyDbId	character; required: FALSE; Unique study identifier to filter on.
locationDbId	character; required: FALSE; Unique location identifier, where the observations were collected.
trialDbId	character; required: FALSE; Unique trial identifier to filter on
programDbId	character; required: FALSE; Unique program identifier to filter on.
seasonDbId	character; required: TRUE; The unique identifier for a season. For backward compatibility it can be a string like '2012', '1957-2004'
observationUnitLevelName	character; required: FALSE; The Observation Unit Level. Returns only the observation unit of the specified Level. References ObservationUnit->observationUnitPosition-> observationLevel->levelName
observationUnitLevelOrder	character; required: FALSE; The Observation Unit Level Order Number. Returns only the observation unit of the specified Level. References ObservationUnit-> observationUnitPosition->observationLevel->levelOrder
observationUnitLevelCode	character; required: FALSE; The Observation Unit Level Code. This parameter should be used together with observationUnitLevelName or observationUnitLevelOrder. References ObservationUnit->observationUnitPosition->observationLevel-> levelCode
observationTimeStampRangeStart	character; required: FALSE; Time stamp to start the range for observations to filter on. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
observationTimeStampRangeEnd	character; required: FALSE; Time stamp to end the range for observations to filter on. Coded in the ISO 8601 standard extended format, where date, time and time zone information needs to be provided (check for example https://www.w3.org/TR/NOTE-datetime).
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 all observations where there are measurements for the given observation variables.

Value

data.frame

Author(s)

Maikel Verouden

References

BrAPI SwaggerHub

See Also

Other brapi-phenotyping: brapi_get_events(), brapi_get_images_imageDbId(), brapi_get_images(), brapi_get_methods_methodDbId(), brapi_get_methods(), brapi_get_observationlevels(), brapi_get_observations_observationDbId(), brapi_get_observations_table(), brapi_get_observationunits_observationUnitDbId(), brapi_get_observationunits_table(), brapi_get_observationunits(), brapi_get_ontologies(), brapi_get_scales_scaleDbId(), brapi_get_scales(), brapi_get_search_images_searchResultsDbId(), brapi_get_search_observations_searchResultsDbId(), brapi_get_search_observationunits_searchResultsDbId(), brapi_get_search_variables_searchResultsDbId(), brapi_get_traits_traitDbId(), brapi_get_traits(), brapi_get_variables_observationVariableDbId(), brapi_get_variables(), brapi_post_images(), brapi_post_methods(), brapi_post_observations(), brapi_post_observationunits(), brapi_post_scales(), brapi_post_search_images(), brapi_post_search_observations(), brapi_post_search_observationunits(), brapi_post_search_variables(), brapi_post_traits(), brapi_post_variables(), brapi_put_images_imageDbId_imagecontent(), brapi_put_images_imageDbId(), brapi_put_methods_methodDbId(), brapi_put_observations_observationDbId(), brapi_put_observationunits_observationUnitDbId(), brapi_put_scales_scaleDbId(), brapi_put_traits_traitDbId(), brapi_put_variables_observationVariableDbId()

Other Observations: brapi_get_observations_observationDbId(), brapi_get_observations_table(), brapi_get_search_observations_searchResultsDbId(), brapi_post_observations(), brapi_post_search_observations(), brapi_put_observations_observationDbId()

Examples

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

## End(Not run)

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