brapi_get_observations_table: get /observations/table

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

get /observations/table

Description

Get a list of Observations in a table format

Usage

brapi_get_observations_table(
  con = NULL,
  Accept = "application/json",
  observationUnitDbId = "",
  germplasmDbId = "",
  observationVariableDbId = "",
  studyDbId = "",
  locationDbId = "",
  trialDbId = "",
  programDbId = "",
  seasonDbId = "",
  observationLevel = "",
  searchResultsDbId = "",
  observationTimeStampRangeStart = "",
  observationTimeStampRangeEnd = ""
)

Arguments

con	list; required: TRUE; BrAPI connection object
Accept	character; required: TRUE; The requested content type which should be returned by the server; default: "application/json", other possible values: "text/csv" "text/tsv"
observationUnitDbId	character; required: FALSE; Unique observation unit data base identifier to filter on.
germplasmDbId	character; required: FALSE; The unique database identifier of a germplasm (accession) to filter on.
observationVariableDbId	character; required: FALSE; The unique database identifier of an observation variable to filter on.
studyDbId	character; required: FALSE; The unique database identifier of a study to filter on.
locationDbId	character; required: FALSE; The unique database identifier of a location where these observations were collected.
trialDbId	character; required: FALSE; The unique database identifier of a trial to filter on.
programDbId	character; required: FALSE; The unique database identifier of a program to filter on.
seasonDbId	character; required: TRUE; The unique identifier for a season to filter on. For backward compatibility it can be a string like '2012', '1957-2004'.
observationLevel	character; required: FALSE; The type of the observation unit. Returns only the observation unit of the specified type; the parent levels identifier can be accessed through observationUnitStructure.
searchResultsDbId	character; required: FALSE; Permanent unique database identifier, which references the search results.
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).

Details

This service is designed to retrieve a table of time dependent observation values as a matrix of Observation Units and Observation Variables. This is also sometimes called a Time Series.

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(), 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(), 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_table(con = con,
                             Accept = "application/json")

## End(Not run)

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