brapi_post_allelematrices_search: post /allelematrices-search

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

post /allelematrices-search

Description

Submit a request to get a Matrix of Allele data

Usage

brapi_post_allelematrices_search(
  con = NULL,
  expandHomozygotes = NA,
  format = as.character(NA),
  markerDbId = "",
  markerProfileDbId = "",
  matrixDbId = "",
  page = 0,
  pageSize = 1000,
  sepPhased = "",
  sepUnphased = "",
  unknownString = ""
)

Arguments

con	list; required: TRUE; BrAPI connection object
expandHomozygotes	logical; required: FALSE; Should homozygotes be expanded (true) or collapsed into a single occurence (false); default: NA, other possible values: TRUE | FALSE
format	character; required: FALSE; The data format of the response data. ie "json", "tsv", etc; default: as.character(NA), other possible values: "csv", "tsv", and depending on the call "flapjack" may be supported.
markerDbId	vector of type character; required: FALSE; An ID which uniquely identifies a Marker; default: "", when using multiple values supply as c("value1", "value2").
markerProfileDbId	vector of type character; required: FALSE; An ID which uniquely identifies a Marker Profile; default: "", when using multiple values supply as c("value1", "value2").
matrixDbId	vector of type character; required: FALSE; An ID which uniquely identifies an Allele Matrix; default: "", when using multiple values supply as c("value1", "value2").
page	integer; required: FALSE; Which page of the "data" array to return. The page indexing starts at 0 (page=0 will return the first page). Default is 0.
pageSize	integer; required: FALSE; The maximum number of items to return per page of the "data" array. Default is 1000.
sepPhased	character; required: FALSE; The string to use as a separator for phased allele calls.; default: "".
sepUnphased	character; required: FALSE; The string to use as a separator for unphased allele calls.; default: "".
unknownString	character; required: FALSE; The string to use as a representation for missing data.; default: "".

Details

This uses a more efficient data structure and pagination for large number of markers.

Use POST when parameter size is greater than 2K bytes.

• If no format is specified, this call returns the data in JSON form.

• If a format (other than JSON) is specified and the server supports this format, it will return the link to the exported data file in the "datafiles" field of the "metadata".

• If more than one format is requested at a time, the server will throw a "501 Not Implemented" error.

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_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 Marker Profiles: brapi_get_allelematrices_search(), brapi_get_allelematrices(), brapi_get_markerprofiles_markerProfileDbId(), brapi_get_markerprofiles()

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