panels: Panel Endpoints

In CytobankAPI: Cytobank API Wrapper for R

Panel Endpoints

Description

Interact with panel endpoints. A collection of channels, the markers being studied on them, and the FCS files this applies to form a panel. Learn more about panels in Cytobank.

Usage

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

## S4 method for signature 'UserSession'
panels.show(
  UserSession,
  experiment_id,
  panel_id,
  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] - panels.list, panels.show : ("default", "raw")
timeout	integer representing the request timeout time in seconds [optional]
panel_id	integer representing a panel ID

Details

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

panels.show Show panel details from an experiment. Outputs a full list with all fields present, or an IDs/names list (See attachments examples section for IDs/names list example).
- Optional output parameter, specify one of the following: ("default", "raw")

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")

## End(Not run)
## Not run: # Full panel list with all fields present, with a dataframe of channels
panels.list(cyto_session, 22)

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

## End(Not run)
## Not run: # Full panel info with all fields present
panels.show(cyto_session, 22, panel_id=2)

## End(Not run)

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