Extract sample names

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

cyto_names(x)

# S3 method for flowFrame
cyto_names(x)

# S3 method for flowSet
cyto_names(x)

# S3 method for GatingHierarchy
cyto_names(x)

# S3 method for GatingSet
cyto_names(x)

# S3 method for list
cyto_names(x)

Arguments

x	object of class flowFrame, flowSet, GatingSet or GatingSet.

Value

names associated with the supplied object.

Author

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

Examples

# Load in CytoExploreRData to access data
library(CytoExploreRData)

# Activation flowSet
fs <- Activation

# Activation GatingSet
gs <- GatingSet(fs)

# flowFrame
cyto_names(fs[[1]])
#> [1] "Activation_1.fcs"

# flowSet
cyto_names(fs)
#>  [1] "Activation_1.fcs"  "Activation_2.fcs"  "Activation_3.fcs" 
#>  [4] "Activation_4.fcs"  "Activation_5.fcs"  "Activation_6.fcs" 
#>  [7] "Activation_7.fcs"  "Activation_8.fcs"  "Activation_9.fcs" 
#> [10] "Activation_10.fcs" "Activation_11.fcs" "Activation_12.fcs"
#> [13] "Activation_13.fcs" "Activation_14.fcs" "Activation_15.fcs"
#> [16] "Activation_16.fcs" "Activation_17.fcs" "Activation_18.fcs"
#> [19] "Activation_19.fcs" "Activation_20.fcs" "Activation_21.fcs"
#> [22] "Activation_22.fcs" "Activation_23.fcs" "Activation_24.fcs"
#> [25] "Activation_25.fcs" "Activation_26.fcs" "Activation_27.fcs"
#> [28] "Activation_28.fcs" "Activation_29.fcs" "Activation_30.fcs"
#> [31] "Activation_31.fcs" "Activation_32.fcs" "Activation_33.fcs"

# GatingHierarchy
cyto_names(gs[[1]])
#> [1] "Activation_1.fcs"

# GatingSet
cyto_names(gs)
#>  [1] "Activation_1.fcs"  "Activation_2.fcs"  "Activation_3.fcs" 
#>  [4] "Activation_4.fcs"  "Activation_5.fcs"  "Activation_6.fcs" 
#>  [7] "Activation_7.fcs"  "Activation_8.fcs"  "Activation_9.fcs" 
#> [10] "Activation_10.fcs" "Activation_11.fcs" "Activation_12.fcs"
#> [13] "Activation_13.fcs" "Activation_14.fcs" "Activation_15.fcs"
#> [16] "Activation_16.fcs" "Activation_17.fcs" "Activation_18.fcs"
#> [19] "Activation_19.fcs" "Activation_20.fcs" "Activation_21.fcs"
#> [22] "Activation_22.fcs" "Activation_23.fcs" "Activation_24.fcs"
#> [25] "Activation_25.fcs" "Activation_26.fcs" "Activation_27.fcs"
#> [28] "Activation_28.fcs" "Activation_29.fcs" "Activation_30.fcs"
#> [31] "Activation_31.fcs" "Activation_32.fcs" "Activation_33.fcs"