harmonize_velo_txis: harness for velocity correction (currently ignorant of...

Description Usage Arguments Value

View source: R/harmonize_velo_txis.R

Description

Harmony is not a Bioconductor package, so the user needs to install it from https://github.com/immunogenomics/harmony prior to using this function. The UMAP projection will be updated to reflect harmonized coordinates unless the user sets UMAP to FALSE when calling the function.

Usage

1
harmonize_velo_txis(txis, colname = "sample", how = "default", iter = 20, ...)

Arguments

txis

a SingleCellExperiment

colname

name of colData column with the batch variable ("sample")

how

how to respect spliced/unspliced relation, currently unused

iter

max.iter.harmony, defaults to 20 (harmony default is 10)

...

arguments to pass to RunHarmony, e.g. max.iter.harmony=20

Value

1
     a SingleCellExperiment with "HARMONY" in reducedDimNames

trichelab/velocessor documentation built on Jan. 5, 2022, 6:27 p.m.