brapi_get_scales: get /scales

View source: R/brapi_get_scales.R

brapi_get_scalesR Documentation

get /scales

Description

Get the Scales

Usage

brapi_get_scales(
  con = NULL,
  scaleDbId = "",
  observationVariableDbId = "",
  externalReferenceID = "",
  externalReferenceSource = "",
  page = 0,
  pageSize = 1000
)

Arguments

con

list; required: TRUE; BrAPI connection object

scaleDbId

character; required: FALSE; The unique identifier for a scale.

observationVariableDbId

character; required: FALSE; The unique identifier for an observation variable.

externalReferenceID

character; required: FALSE; An external reference ID. Could be a simple string or a URI. (use with externalReferenceSource parameter)

externalReferenceSource

character; required: FALSE; An identifier for the source system or database of an external reference (use with externalReferenceID parameter)

page

integer; required: FALSE; Used to request a specific page of data to be returned. 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

Returns a list of Scales available on a server.

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_table(), brapi_get_observations(), brapi_get_observationunits_observationUnitDbId(), brapi_get_observationunits_table(), brapi_get_observationunits(), brapi_get_ontologies(), brapi_get_scales_scaleDbId(), 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 Scales: brapi_get_scales_scaleDbId(), brapi_post_scales(), brapi_put_scales_scaleDbId()

Examples

## Not run: 
con <- brapi_db()$testserver
brapi_get_scales(con = con)

## End(Not run)


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