cyto_names: Extract sample names

Description Usage Arguments Value Author(s) Examples

View source: R/cyto-helpers.R

Description

Simply a convenient and autocomplete-friendly wrapper around identifier sampleNames to extract the sample names from flowFrame, flowSet GatingHierarchy or GatingSet. Anonymous flowFrame identifiers will be converted to "Combined Events".

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
cyto_names(x)

## S3 method for class 'flowFrame'
cyto_names(x)

## S3 method for class 'flowSet'
cyto_names(x)

## S3 method for class 'GatingHierarchy'
cyto_names(x)

## S3 method for class 'GatingSet'
cyto_names(x)

## S3 method for class 'list'
cyto_names(x)

Arguments

x

object of class flowFrame, flowSet, GatingSet or GatingSet.

Value

names associated with the supplied object.

Author(s)

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

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
# Load in CytoExploreRData to access data
library(CytoExploreRData)

# Activation flowSet
fs <- Activation

# Activation GatingSet
gs <- GatingSet(fs)

# flowFrame
cyto_names(fs[[1]])

# flowSet
cyto_names(fs)

# GatingHierarchy
cyto_names(gs[[1]])

# GatingSet
cyto_names(gs)

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