gtMethod-class: A class to represent a gating method.

gtMethod-classR Documentation

A class to represent a gating method.

Description

A gating method object contains the specifics for generating the gates.

Slots

name

a character specifying the name of the gating method

dims

a character vector specifying the dimensions (channels or markers) of the gate

args

a list specifying the arguments passed to gating function

groupBy

a character or integer specifying how to group the data. If character, group the data by the study variables (columns in pData). If integer, group the data by every N samples.

collapse

a logical specifying wether to collapse the data within group before gating. it is only valid when groupBy is specified

Examples

 ## Not run: 
     gt <- gatingTemplate(system.file("extdata/gating_template/tcell.csv",package = "openCyto"))
     gh_pop_get_gate(gt, '2', '3')

## End(Not run)

RGLab/openCyto documentation built on Nov. 7, 2024, 9:23 p.m.