peacoqc: PeacoQC Endpoints

In CytobankAPI: Cytobank API Wrapper for R

PeacoQC Endpoints

Description

Interact with PeacoQC using these endpoints.

Usage

## S4 method for signature 'UserSession,PeacoQC'
peacoqc.copy_settings(
  UserSession,
  peacoqc,
  output = "default",
  timeout = UserSession@short_timeout
)

## S4 method for signature 'UserSession'
peacoqc.list(
  UserSession,
  experiment_id,
  output = "default",
  timeout = UserSession@short_timeout
)

## S4 method for signature 'UserSession'
peacoqc.new(
  UserSession,
  experiment_id,
  peaco_qc_name,
  timeout = UserSession@long_timeout
)

## S4 method for signature 'UserSession,PeacoQC'
peacoqc.rename(
  UserSession,
  peacoqc,
  peaco_qc_name,
  timeout = UserSession@short_timeout
)

## S4 method for signature 'UserSession,PeacoQC'
peacoqc.run(
  UserSession,
  peacoqc,
  output = "default",
  timeout = UserSession@long_timeout
)

## S4 method for signature 'UserSession'
peacoqc.show(
  UserSession,
  experiment_id,
  peaco_qc_id,
  timeout = UserSession@short_timeout
)

## S4 method for signature 'UserSession,PeacoQC'
peacoqc.status(
  UserSession,
  peacoqc,
  output = "default",
  timeout = UserSession@long_timeout
)

## S4 method for signature 'UserSession,PeacoQC'
peacoqc.update(UserSession, peacoqc, timeout = UserSession@long_timeout)

Arguments

UserSession	Cytobank UserSession object
peacoqc	Cytobank PeacoQC object
output	character representing the output format [optional] - peacoqc.list, peacoqc.run, peacoqc.status, peacoqc.copy_settings : ("default", "raw")
timeout	integer representing the request timeout time in seconds [optional]
experiment_id	integer representing an experiment ID
peaco_qc_name	character representing a new PeacoQC name
peaco_qc_id	integer representing a PeacoQC ID

Details

peacoqc.copy_settings Copy PeacoQC settings from an experiment and returns a PeacoQC object.

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

peacoqc.new Create a new PeacoQC advanced analysis from an experiment and returns a PeacoQC object.

peacoqc.rename Rename a PeacoQC from an experiment and returns a PeacoQC object.

peacoqc.run Run a PeacoQC from an experiment.

peacoqc.show Show PeacoQC details from an experiment and returns a PeacoQC object.

peacoqc.status Show the status of a PeacoQC from an experiment.

peacoqc.update Update a PeacoQC from an experiment and returns the new PeacoQC object.

Examples

## Not run: # 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")

# cyto_peacoqc refers to a PeacoQC object that is created from PeacoQC endpoints
#   examples: peacoqc.new, peacoqc.show (see details section for more)

## End(Not run)
## Not run: peacoqc.copy_settings(cyto_session, peacoqc=cyto_peacoqc)

## Not run: # Dataframe of all PeacoQCs with all fields present
peacoqc.list(cyto_session, 22)

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

## End(Not run)
## Not run: peacoqc.new(cyto_session, 22, peaco_qc_name="My new PeacoQC")

## Not run: peacoqc.rename(cyto_session, peacoqc=cyto_peacoqc,
    peaco_qc_name="My updated PeacoQC name")

## End(Not run)
## Not run: peacoqc.run(cyto_session, peacoqc=cyto_peacoqc)

## Not run: peacoqc.show(cyto_session, experiment_id=22, peaco_qc_id=2)

## Not run: peacoqc.status(cyto_session, peacoqc=cyto_peacoqc)

## Not run: peacoqc.update(cyto_session, peacoqc=cyto_peacoqc)

CytobankAPI documentation built on April 21, 2023, 9:08 a.m.