cyto_convert: Convert between cytometry objects

Description Usage Arguments Value Author(s) Examples

View source: R/cyto-helpers.R

Description

Convert between cytometry objects

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
cyto_convert(x, ...)

## S3 method for class 'flowFrame'
cyto_convert(x, return = "flowFrame", ...)

## S3 method for class 'flowSet'
cyto_convert(x, return = "flowSet", ...)

## S3 method for class 'GatingHierarchy'
cyto_convert(x, parent = "root", return = "GatingHierarchy", ...)

## S3 method for class 'GatingSet'
cyto_convert(x, parent = "root", return = "GatingSet", ...)

Arguments

x

flowFrame, flowSet, GatingHierarchy, GatingSet.

...

not in use.

return

either 'flowFrame', 'flowSet', 'GatingHierarchy', 'GatingSet', coerced 'flowFrame list' or coerced 'flowSet list'. GatingSet and flowSet objects can also be converted to a 'list of flowFrames'.

parent

name of parent population to extract from GatingHierarchy and GatingSet objects.

Value

object specified by 'return' argument.

Author(s)

Dillon Hammill, Dillon.Hammill@anu.edu.au

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Load in CytoExploreRData to access data
library(CytoExploreRData)

# Convert flowSet to 'list of flowFrames'
cyto_convert(Activation, "list of flowFrames")

# Convert flowSet to 'flowFrame'
cyto_convert(Activation, "flowFrame")

# Convert GatingSet to flowFrame
cyto_convert(GatingSet(Activation), "flowFrame", parent = "root")

DillonHammill/CytoExploreR documentation built on July 9, 2020, 1:53 a.m.