brapi_put_studies_studyDbId_layouts: put /studies/{studyDbId}/layouts

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

put /studies/{studyDbId}/layouts

Description

Update an existing Study with new layout details

Usage

brapi_put_studies_studyDbId_layouts(con = NULL, studyDbId = "", layout = "")

Arguments

con	list; required: TRUE; BrAPI connection object
studyDbId	character; required: TRUE; Identifier of the study. Usually a number, could be alphanumeric.
layout	data.frame; required: TRUE, with default: ""; data.frame of observation unit position data entities which need to be updated. Each row in the layout argument data .frame corresponds to a single entity and requires to contain the following columns: blockNumber vector of type character; to specify the blocknumber positions of each observation unit entryType vector of type character; to specify the entrytype of each observation unit with possible values: "CHECK" | "FILLER" | "TEST" observationUnitDbId vector of type character; to specify the internal database identifier of each observation unit. positionCoordinateX vector of type character; to specify the X position coordinate for each observation unit. Different systems may use different coordinate systems. positionCoordinateXType vector of type character; to specify the type of X positional coordinate used for each observation unit. Must be one of the following values: LONGITUDE ISO 6709 standard, WGS84 geodetic datum. See "Location Coordinate Encoding" for details LATITUDE ISO 6709 standard, WGS84 geodetic datum. See "Location Coordinate Encoding" for details PLANTED_ROW The physical planted row number PLANTED_INDIVIDUAl The physical counted number, could be independEnt or within a planted row GRID_ROW The row index number of a square grid overlay GRID_COL The column index number of a square grid overlay MEASURED_ROW The distance in meters from a defined 0th row MEASURED_COL The distance in meters from a defined 0th column positionCoordinateY vector of type character; to specify the Y position coordinate for each observation unit. Different systems may use different coordinate systems. positionCoordinateYType vector of type character; to specify the type of positional Y coordinate used for each observation unit. Must be one of the following values: LONGITUDE ISO 6709 standard, WGS84 geodetic datum. See "Location Coordinate Encoding" for details LATITUDE ISO 6709 standard, WGS84 geodetic datum. See "Location Coordinate Encoding" for details PLANTED_ROW The physical planted row number PLANTED_INDIVIDUAl The physical counted number, could be independEnt or within a planted row GRID_ROW The row index number of a square grid overlay GRID_COL The column index number of a square grid overlay MEASURED_ROW The distance in meters from a defined 0th row MEASURED_COL The distance in meters from a defined 0th column replicate vector of type character; to specify the replicate number of each observation unit. The Examples Section shows an example of how to construct the layout argument as a data.frame object.

Details

Update the layout data for a set of observation units within a study. A layout data.frame is a subset of fields within an observationUnit. If any of the fields in the request data.frame (as defined in the layout function argument) is missing, that piece of data will not be updated. The response should match the structure of the response from GET studies/{studyDbId}/layout as implemented in the brapi_get_studies_studyDbId_layout() function, but it should only contain the layout objects which have been updated by the PUT request.

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_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_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_post_studies_studyDbId_table(), brapi_put_studies_studyDbId_observations(), brapi_put_studies_studyDbId_observationunits()

Examples

## Not run: 

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

# Create a layout data.frame
# containing the fields to be updated
layout <- data.frame(
  blockNumber = c("12"),
  entryType = c("CHECK"),
  observationUnitDbId = c("1"),
  positionCoordinateX = c("12"),
  positionCoordinateXType = c("GRID_COL"),
  positionCoordinateY = c("12"),
  positionCoordinateYType = c("GRID_ROW"),
  replicate = c("1"))

# Make put /studies/{studyDbId}/layout call
brapi_put_studies_studyDbId_layouts(con = con, studyDbId = '1001', layout = layout)

## End(Not run)

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