All parameters are slots within the gate object

Gate(
  counter = NA_integer_,
  assay_name = NA_character_,
  input_cells = list(),
  input_coords = data.frame(),
  subset_cells = list(),
  subset_coords = data.frame(),
  x_axis = NA_character_,
  y_axis = NA_character_,
  gate_coords = list(),
  name_subset_cells = NA_character_,
  num_input_cells = NA_integer_,
  num_subset_cells = NA_integer_,
  total_num_cells_in_sample = NA_integer_,
  pct_subset_from_previous = NA_real_,
  pct_subset_from_total = NA_real_
)

Arguments

counter

integer to keep track of gate number

assay_name

character. Seurat object assay gates on

input_cells

list. cells plotted

input_coords

dataframe of plotted cell coordinates

subset_cells

list. cells selected

subset_coords

dataframe of selected cell coordinates

x_axis

character. Feature on x-axis

y_axis

character. Feature on y-axis

gate_coords

list. coordinates of drawn gate

name_subset_cells

character. user ipute of selected cell subset name

num_input_cells

integer. number of total cells on plot

num_subset_cells

integer. number of cells selected

total_num_cells_in_sample

integer. number of total cells in seurat object

pct_subset_from_previous

numeric. percentage of cells selected from cells plotted

pct_subset_from_total

numeric. percentage of cells selected from cells in Seurat object

Value

Gate class object

Examples

# create Gate object
example_gate <- Gate(counter = as.integer(1),
                   assay_name = "example",
                   input_cells = list(c("a", "b", "c")),
                   input_coords =  data.frame(x=c(1,2,3),y=c(4,5,6)),
                   subset_cells = list(c("a","b")), 
                   subset_coords = data.frame(x=c(1,2),y=c(4,5)), 
                   x_axis = "ADT-A", 
                   y_axis = "ADT-B", 
                   gate_coords = list(x=c(1,2,3,4),y=c(5,6,7,8)), 
                   name_subset_cells = "example_cells_A", 
                   num_input_cells = as.integer(1000), 
                   num_subset_cells = as.integer(500), 
                   total_num_cells_in_sample = as.integer(1000),
                   pct_subset_from_previous = 50, 
                   pct_subset_from_total = 50)