normCytof {CATALYST} | R Documentation |
an implementation of Finck et al.'s normalization of mass cytometry data using bead standards with automated bead gating.
normCytof( x, beads, k = 500, trim = 5, remove_beads = TRUE, norm_to = NULL, assays = c("counts", "exprs"), overwrite = TRUE, transform = TRUE, cofactor = NULL, plot = TRUE, verbose = TRUE )
x |
|
beads |
|
k |
integer width of the median window used for bead smoothing (affects visualizations only!). |
trim |
a single non-negative numeric.
A median+/- |
remove_beads |
logical. If TRUE, bead events will be removed from
the input |
norm_to |
a |
assays |
lnegth 2 character string specifying
which assay data to use; both should be in |
overwrite |
logical; should the specified |
transform |
logical; should normalized counts be
arcsinh-transformed with the specified |
cofactor |
numeric cofactor(s) to use for optional
arcsinh-transformation when |
plot |
logical; should bead vs. DNA scatters and smoothed bead intensities before vs. after normalization be included in the output? |
verbose |
logical; should extra information on progress be reported? |
a list of the following SingleCellExperiment
...
data
:
The filtered input SCE (when remove_beads = TRUE
);
otherwise, colData
columns is_bead
and remove
indicate whether an event as been identified as a bead or doublet.
If overwrite = FALSE
, assays normcounts/exprs
are added;
otherwise, the specified counts/exprs
assays are overwritten.
beads
, removed
:
SCEs containing subsets of events identified as beads
and that were removed, respectively. The latter includes
bead-cell and cell-cell doublets)
...and ggplot
objects:
scatter
: scatter plot of DNA vs. bead
intensities with indication of the applied gates
lines
: running-median smoothed bead
intensities before and after normalization
Helena L Crowell helena.crowell@uzh.ch
Finck, R. et al. (2013). Normalization of mass cytometry data with bead standards. Cytometry A 83A, 483-494.
data(raw_data) sce <- prepData(raw_data) # apply normalization & write normalized data to separate assays res <- normCytof(sce, beads = "dvs", k = 80, overwrite = FALSE) ncol(res$beads) # no. of bead events ncol(res$removed) # no. of events removed res$scatter # plot DNA vs. bead intensities including applied gates res$lines # plot smoothed bead intensities before vs. after normalization # filtered SCE now additionally includes # normalized count & expression data assayNames(res$data)