guessPanel {CATALYST} | R Documentation

## Guess parameter panel

### Description

Helper function to parse information from the `parameters` slot of a `flowFrame`/`flowSet`.

### Usage

    guessPanel(x, ...)

    ## S4 method for signature 'flowFrame'
    guessPanel(x)

    ## S4 method for signature 'flowSet'
    guessPanel(x, index = 1)

### Arguments

`x` | a `flowFrame` or `flowSet`.
`...` | optional arguments.
`index` | numeric. If `x` is a `flowSet` object, this index specifies which `flowFrame` to extract.

### Value

a `data.frame` with the following columns:

- `name`: the parameter name as extracted from the input `flowFrame`,

- `desc`: the parameter description as extracted from the input `flowFrame`,

- `antigen`: the targeted protein markers, and

- `use_channel`: logical. If TRUE, the channel is expected to contain a marker and will be kept.

### Author(s)

Mark D Robinson, and Helena Lucia Crowell helena.crowell@uzh.ch

### Examples

    # examplary data with Time, DNA, BC channels, etc.
    data(raw_data)
    guessPanel(raw_data)

[Package CATALYST version 1.8.7 Index]