dimensionality_reduction: DimensionalityReduction Endpoints

Description

Interact with DimensionalityReduction advanced analyses using these endpoints.

Usage

# S4 method for UserSession,DimensionalityReduction
dimensionality_reduction.copy_settings(
  UserSession,
  dimensionality_reduction,
  output = "default",
  timeout = UserSession@short_timeout
)
# S4 method for UserSession,DimensionalityReduction
dimensionality_reduction.delete(
  UserSession,
  dimensionality_reduction,
  timeout = UserSession@short_timeout
)
# S4 method for UserSession
dimensionality_reduction.list(
  UserSession,
  experiment_id,
  analysis_type,
  output = "default",
  timeout = UserSession@short_timeout
)
# S4 method for UserSession
dimensionality_reduction.new(
  UserSession,
  experiment_id,
  analysis_name,
  analysis_type,
  timeout = UserSession@long_timeout
)
# S4 method for UserSession,DimensionalityReduction
dimensionality_reduction.rename(
  UserSession,
  dimensionality_reduction,
  analysis_name,
  timeout = UserSession@short_timeout
)
# S4 method for UserSession,DimensionalityReduction
dimensionality_reduction.run(
  UserSession,
  dimensionality_reduction,
  output = "default",
  timeout = UserSession@long_timeout
)
# S4 method for UserSession
dimensionality_reduction.show(
  UserSession,
  experiment_id,
  analysis_id,
  analysis_type,
  timeout = UserSession@short_timeout
)
# S4 method for UserSession,DimensionalityReduction
dimensionality_reduction.status(
  UserSession,
  dimensionality_reduction,
  output = "default",
  timeout = UserSession@long_timeout
)
# S4 method for UserSession,DimensionalityReduction
dimensionality_reduction.update(
  UserSession,
  dimensionality_reduction,
  timeout = UserSession@long_timeout
)

Arguments

UserSession: Cytobank UserSession object
dimensionality_reduction: Cytobank DimensionalityReduction object
output: character representing the output format [optional]
- dimensionality_reduction.list, dimensionality_reduction.run, dimensionality_reduction.status : ("default", "raw")
timeout: integer representing the request timeout time in seconds [optional]
experiment_id: integer representing an experiment ID
analysis_type: character representing the Dimensionality Reduction type (tSNE-CUDA, opt-SNE, UMAP, or viSNE)
analysis_name: character the name of the Dimensionality Reduction analysis
analysis_id: integer representing the Dimensionality Reduction analysis ID

Details

dimensionality_reduction.copy_settings Copy DimensionalityReduction advanced analysis settings from an experiment and returns a DimensionalityReduction object.

dimensionality_reduction.delete Delete a DimensionalityReduction advanced analysis from an experiment.

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

dimensionality_reduction.new Create a new DimensionalityReduction advanced analysis from an experiment and returns a DimensionalityReduction object.

dimensionality_reduction.rename Rename a DimensionalityReduction advanced analysis from an experiment and returns the new name.

dimensionality_reduction.run Run a DimensionalityReduction advanced analysis from an experiment.

dimensionality_reduction.show Show DimensionalityReduction advanced analysis details from an experiment and returns a DimensionalityReduction object.

dimensionality_reduction.status Show the status of a DimensionalityReduction advanced analysis from an experiment.

dimensionality_reduction.update Update a DimensionalityReduction advanced analysis from an experiment and returns the new DimensionalityReduction object.