getIndices,GatingHierarchy,character-method {flowWorkspace} | R Documentation

## Get the membership indices for each event with respect to a particular gate in a GatingHierarchy

### Description

Returns a logical vector that describes whether each event in a sample is included or excluded by this gate.

### Usage

    ## S4 method for signature 'GatingHierarchy,character'
    getIndices(obj, y)

    gh_pop_get_indices(obj, y)

### Arguments

`obj` | A `GatingHierarchy` representing a sample.
`y` | A `character` giving the name or full(/partial) gating path of the population / node of interest.

### Details

Returns a logical vector that describes whether each event in the data file is included in the given gate of this `GatingHierarchy`. The indices are for all events in the file, and do not reflect the population counts relative to the parent but relative to the root. To get population frequencies relative to the parent one cross-tabulate the indices of `y` with the indices of its parent.

### Value

A logical vector of length equal to the number of events in the FCS file that determines whether each event is or is not included in the current gate.

### Note

Generally you should not need to use `gh_pop_get_indices` but the more convenient methods `gh_pop_get_proportion` and `gh_pop_compare_stats` which return population frequencies relative to the parent node. The indices returned reference all events in the file and are not directly suitable for computing population statistics, unless subsets are taken with respect to the parent populations.

### See Also

`gh_pop_compare_stats`

### Examples

      ## Not run:
        #G is a gating hierarchy
        #Return the indices for population 5 (topological sort)
        gh_pop_get_indices(G,gs_get_pop_paths(G,tsort=TRUE)[5]);

    ## End(Not run)

[Package flowWorkspace version 3.34.1 Index]