brapi_post_studies_studyDbId_table: post /studies/{studyDbId}/table

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

post /studies/{studyDbId}/table

Description

Submit new Observations in a table format for a specific Study

Usage

brapi_post_studies_studyDbId_table(
  con = NULL,
  studyDbId = "",
  data = "",
  headerRow = "",
  observationVariableDbIds = ""
)

Arguments

con	list; required: TRUE; BrAPI connection object
studyDbId	character; required: TRUE; Identifier of the study. Usually a number, could be alphanumeric.
data	data.frame; required: TRUE; data frame of observation data recorded for different observation variables across different observation units; default: "". The Examples Section shows an example of how to construct the data argument as a data.frame.
headerRow	vector of type character; required: TRUE; The header row describing the data frame. Append 'observationVariableDbIds' for complete header row of the table. This vector of type character should contain any or all of the following strings; year, studyDbId, studyName, locationDbId, locationName, germplasmDbId, germplasmName, observationUnitDbId, plotNumber, replicate, blockNumber, entryType, X, Y; default: "", when using multiple values supply as c("year", "studyDbId", ...).
observationVariableDbIds	vector of type character; required: TRUE; The list of observation variable identifiers which have values recorded for them in the data frame. Append to the 'headerRow' for complete header row; default: "", when using multiple values supply as c("value1", "value2").

Details

This call can be used to create new observations in bulk.

Note: If you need to update any existing observation, please use PUT /studies/{studyDbId}/observations. This call should only be used to create NEW observations.

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_observations(), 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_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_observations(), 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_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_observations(), brapi_get_studies_studyDbId_observationunits(), brapi_get_studies_studyDbId_table(), brapi_post_phenotypes(), brapi_post_search_observationtables(), brapi_post_search_observationunits(), brapi_put_studies_studyDbId_observations(), brapi_put_studies_studyDbId_observationunits()

Examples

## Not run: 

# Create a connection object
con <- brapi_db()$testserver

# Create an example data.frame data object
data <- data.frame(
  year = c("2019", "2019", "2020", "2020"),
  studyDbId = c("1001", "1001", "1001", "1001"),
  studyName = c("Study 1", "Study 1", "Study 1", "Study 1"),
  locationDbId = c("1", "1", "1", "1"),
  locationName = c("Peru", "Peru", "Peru", "Peru"),
  germplasmDbId = c("1", "1", "2", "2"),
  germplasmName  = c("Name001", "Name001", "Name002", "Name002"),
  observationUnitDbId = c("1", "2", "3", "4"),
  plotNumber = c("1", "1", "2", "2"),
  replicate = c("0", "0", "0", "0"),
  blockNumber = c("1", "1", "1", "1"),
  entryType = c("FILLER", "TEST", "FILLER", "FILLER"),
  X = c("1", "1", "1", "1"),
  Y = c("1", "2", "3", "4"),
  'MO_123:100002' = c("1.0", "1.1", "1.2", "1.3"),
  'MO_123:100003' = c("2.1", "2.2", "2.3", "2.4"),
  'MO_123:100005' = c("light blue", "blue", "dark blue", "blue"),
  'MO_123:100006' = c("4.3", "4.2", "4.0", "4.1"))

# Create a headerRow character vector
headerRow <- c("year",
               "studyDbId",
               "studyName",
               "locationDbId",
               "locationName",
               "germplasmDbId",
               "germplasmName",
               "observationUnitDbId",
               "plotNumber",
               "replicate",
               "blockNumber",
               "entryType",
               "X",
               "Y")

# Create an observationVariableDbIds character vector
observationVariableDbIds <- c("MO_123:100002",
                              "MO_123:100003",
                              "MO_123:100005",
                              "MO_123:100006")

# Make post /studies/{studyDbId}/table call
brapi_post_studies_studyDbId_table(con = con,
                                   studyDbId = "1001",
                                   data = data,
                                   headerRow = headerRow,
                                   observationVariableDbIds = observationVariableDbIds)

## End(Not run)

mverouden/brapir-v1 documentation built on April 11, 2022, 9:17 a.m.