HexTemplate: Create a HexTemplate Object

Description Usage Arguments Value Examples

View source: R/HexTemplate.R

Description

Create a HexTemplate Object

Usage

1
2
3
4
5
6
7
8
HexTemplate(
  flowset,
  xChannel,
  yChannel,
  xbins = 20,
  metadata = data.frame(),
  trans_fun = log10
)

Arguments

flowset

A flowCore flowSet

xChannel

A string representing the x-axis channel

yChannel

A string representing the y-axis channel

xbins

Number of hexagons on the x-axis - 1

metadata

A data.frame containing metadata. Column names should be the group names.

trans_fun

A function to transform the data. Standard is log10. return if data should not be transformed.

Value

A HexTemplate

Examples

1
2
3
4
5
#get example fcs
#get example metadata
#show available channels
colnames(fcs)
hexT <- HexTemplate(flowset = fcs, xChannel = "SSC-H", yChannel = "DAPI-H", metadata)

AG-ESSER/HexTemplatesFCS documentation built on Dec. 31, 2020, 9:44 a.m.