R: Retrieve a specific keyword for a specific sample in a...

keyword,GatingHierarchy,character-method {flowWorkspace}

R Documentation

Retrieve a specific keyword for a specific sample in a `GatingHierarchy` or or set of samples in a `GatingSet` or `GatingSetList`

Description

Retrieve a specific keyword for a specific sample in a GatingHierarchy or or set of samples in a GatingSet or GatingSetList

Usage

## S4 method for signature 'GatingHierarchy,character'
keyword(object, keyword)

## S4 method for signature 'GatingHierarchy,missing'
keyword(object, keyword = "missing", ...)

## S4 method for signature 'GatingSet,missing'
keyword(object, keyword = "missing", ...)

## S4 method for signature 'GatingSet,character'
keyword(object, keyword)

## S4 method for signature 'GatingSetList,missing'
keyword(object, keyword = "missing", ...)

## S4 method for signature 'GatingSetList,character'
keyword(object, keyword)

Arguments

`object`	`GatingHierarchy` or `GatingSet` or `GatingSetList`
`keyword`	`character` specifying keyword name. When `missing`, extract all keywords.
`...`	other arguments passed to `keyword-methods`

Details

See keyword in Package ‘flowCore’

Examples

    ## Not run: 
      #get all the keywords from all samples
      keyword(G)
      #get all the keywords from one sample
      keyword(G[[1]])
      # filter the instrument setting
      keyword(G[[1]], compact = TRUE)
      #get single keyword from all samples
      keyword(G, "FILENAME")
      #get single keyword from one sample
      keyword(G[[1, "FILENAME")
    
## End(Not run)

[Package flowWorkspace version 3.26.9 Index]