CytobankAPI (version 2.2.0)

scales: Scale Endpoints

Description

Interact with scale endpoints. Data are rarely presented exactly as they were acquired on the instrument. Learn more about data scaling.

Usage

# S4 method for UserSession
scales.list(
  UserSession,
  experiment_id,
  output = "default",
  timeout = UserSession@short_timeout
)
# S4 method for UserSession
scales.show(
  UserSession,
  experiment_id,
  scale_id,
  output = "default",
  timeout = UserSession@short_timeout
)
# S4 method for UserSession
scales.update(
  UserSession,
  scale,
  output = "default",
  timeout = UserSession@short_timeout
)

Arguments

UserSession

Cytobank UserSession object

experiment_id

integer representing an experiment ID

output

character representing the output format [optional]
- scales.list, scales.show, scales.update : ("default", "raw")

timeout

integer representing the request timeout time in seconds

scale_id

integer representing a scale ID

scale

dataframe representing a scale

Details

scales.list List all scales from an experiment. Outputs a dataframe [default] or raw list with all fields present.
- Optional output parameter, specify one of the following: ("default", "raw")

scales.show Show scale details from an experiment. - Optional output parameter, specify one of the following: ("default", "raw")

scales.update Update a single scale from an experiment. (all parameters are optional, except for experiment_id and scale_id)
- Scale Types -- 1: Linear, 2: Log, 4: Arcsinh
- Optional output parameter, specify one of the following: ("default", "raw")

Examples

if (FALSE) # Authenticate via username/password
cyto_session <- authenticate(site="premium", username="cyril_cytometry", password="cytobank_rocks!")
# Authenticate via auth_token
cyto_session <- authenticate(site="premium", auth_token="my_secret_auth_token")

if (FALSE) # Dataframe of all scales with all fields present
scales.list(cyto_session, 22)

# Raw list of all scales with all fields present
scales.list(cyto_session, 22, output="raw")

if (FALSE) scales.show(cyto_session, 22, scale_id=2)

if (FALSE) # Update any number of parameters (scale_type, cofactor, minimum, maximum)
# Scale Types -- 1: Linear, 2: Log, 4: Arcsinh
scales.update(cyto_session, scale=cyto_scale)