brapi_get_studies_studyDbId_observations: get /studies/{studyDbId}/observations

View source: R/brapi_get_studies_studyDbId_observations.R

brapi_get_studies_studyDbId_observationsR Documentation

get /studies/{studyDbId}/observations

Description

Get the Observations associated with a specific Study

Usage

brapi_get_studies_studyDbId_observations(
  con = NULL,
  studyDbId = "",
  observationVariableDbIds = "",
  page = 0,
  pageSize = 1000
)

Arguments

con

list; required: TRUE; BrAPI connection object

studyDbId

character; required: TRUE; Identifier of the study. Usually a number, could be alphanumeric.

observationVariableDbIds

vector of type character; required: FALSE; Numeric id of that variable (combination of trait, unit and method)

page

integer; required: FALSE; Which result page is requested. 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. observationTimestamp should be ISO8601 format with timezone -> YYYY-MM-DDThh:mm:ss+hhmm

Value

data.frame

Author(s)

brapir generator package

References

BrAPI SwaggerHub

See Also

Other brapi_1.3: brapi_get_allelematrices_search(), brapi_get_allelematrices(), brapi_get_attributes_categories(), brapi_get_attributes(), brapi_get_breedingmethods_breedingMethodDbId(), brapi_get_breedingmethods(), brapi_get_calls(), brapi_get_commoncropnames(), brapi_get_germplasm_germplasmDbId_attributes(), brapi_get_germplasm_germplasmDbId_markerprofiles(), brapi_get_germplasm_germplasmDbId_mcpd(), brapi_get_germplasm_germplasmDbId_pedigree(), brapi_get_germplasm_germplasmDbId_progeny(), brapi_get_germplasm_germplasmDbId(), brapi_get_germplasm(), brapi_get_images_imageDbId(), brapi_get_images(), brapi_get_lists_listDbId(), brapi_get_lists(), brapi_get_locations_locationDbId(), brapi_get_locations(), brapi_get_maps_mapDbId_positions_linkageGroupName(), brapi_get_maps_mapDbId_positions(), brapi_get_maps_mapDbId(), brapi_get_maps(), brapi_get_markerprofiles_markerProfileDbId(), brapi_get_markerprofiles(), brapi_get_markers_markerDbId(), brapi_get_markers(), brapi_get_methods_methodDbId(), brapi_get_methods(), brapi_get_observationlevels(), brapi_get_observationunits(), brapi_get_ontologies(), brapi_get_people_personDbId(), brapi_get_people(), brapi_get_programs(), brapi_get_samples_sampleDbId(), brapi_get_samples(), brapi_get_scales_scaleDbId(), brapi_get_scales(), brapi_get_search_germplasm_searchResultsDbId(), brapi_get_search_images_searchResultsDbId(), brapi_get_search_markers_searchResultsDbId(), brapi_get_search_observationtables_searchResultsDbId(), brapi_get_search_observationunits_searchResultsDbId(), brapi_get_search_programs_searchResultsDbId(), brapi_get_search_samples_searchResultsDbId(), brapi_get_search_studies_searchResultsDbId(), brapi_get_search_variables_searchResultsDbId(), brapi_get_seasons(), brapi_get_studies_studyDbId_germplasm(), brapi_get_studies_studyDbId_layouts(), brapi_get_studies_studyDbId_observationunits(), brapi_get_studies_studyDbId_observationvariables(), brapi_get_studies_studyDbId_table(), brapi_get_studies_studyDbId(), brapi_get_studies(), brapi_get_studytypes(), brapi_get_traits_traitDbId(), brapi_get_traits(), brapi_get_trials_trialDbId(), brapi_get_trials(), brapi_get_variables_observationVariableDbId(), brapi_get_variables(), brapi_get_vendor_orders_orderId_plates(), brapi_get_vendor_orders_orderId_results(), brapi_get_vendor_orders_orderId_status(), brapi_get_vendor_orders(), brapi_get_vendor_plates_submissionId(), brapi_get_vendor_specifications(), brapi_post_allelematrices_search(), brapi_post_images(), brapi_post_lists_listDbId_items(), brapi_post_lists(), brapi_post_methods(), brapi_post_people(), brapi_post_phenotypes(), brapi_post_scales(), brapi_post_search_germplasm(), brapi_post_search_images(), brapi_post_search_markers(), brapi_post_search_observationtables(), brapi_post_search_observationunits(), brapi_post_search_programs(), brapi_post_search_samples(), brapi_post_search_studies(), brapi_post_search_variables(), brapi_post_studies_studyDbId_table(), brapi_post_traits(), brapi_post_vendor_orders(), brapi_post_vendor_plates(), brapi_put_images_imageDbId_imagecontent(), brapi_put_images_imageDbId(), brapi_put_lists_listDbId(), brapi_put_methods_methodDbId(), brapi_put_people_personDbId(), brapi_put_samples(), brapi_put_scales_scaleDbId(), brapi_put_studies_studyDbId_layouts(), brapi_put_studies_studyDbId_observations(), brapi_put_studies_studyDbId_observationunits(), brapi_put_traits_traitDbId()

Other Studies: brapi_get_search_studies_searchResultsDbId(), brapi_get_seasons(), brapi_get_studies_studyDbId_germplasm(), brapi_get_studies_studyDbId_layouts(), brapi_get_studies_studyDbId_observationunits(), brapi_get_studies_studyDbId_observationvariables(), brapi_get_studies_studyDbId_table(), brapi_get_studies_studyDbId(), brapi_get_studies(), brapi_get_studytypes(), brapi_post_search_studies(), brapi_post_studies_studyDbId_table(), brapi_put_studies_studyDbId_layouts(), brapi_put_studies_studyDbId_observations(), brapi_put_studies_studyDbId_observationunits()

Other Observations: brapi_get_observationlevels(), brapi_get_observationunits(), brapi_get_search_observationtables_searchResultsDbId(), brapi_get_search_observationunits_searchResultsDbId(), brapi_get_studies_studyDbId_observationunits(), brapi_get_studies_studyDbId_table(), brapi_post_phenotypes(), brapi_post_search_observationtables(), brapi_post_search_observationunits(), brapi_post_studies_studyDbId_table(), brapi_put_studies_studyDbId_observations(), brapi_put_studies_studyDbId_observationunits()


mverouden/brapir documentation built on April 10, 2022, 5:36 p.m.