R/run_doubletfinder.R
run_doubletfinder.Rd
Runs the doubletfinder algorithm on the SingleCellExperiment. Returns a SingleCellExperiment annotated with is_singlet and tSNE coordinates.
run_doubletfinder(
sce,
pK = NULL,
pca_dims = 10,
var_features = 2000,
vars_to_regress_out = "nCount_RNA",
doublet_rate = 0,
dpk = 8,
num_cores = max(1, future::availableCores() - 2)
)
a SingleCellExperiment object
a pK value to use in place of a parameter sweep
the number of principal components to use
the top n variable features to use
the variables to regress out
either a fixed doublet rate (e.g. 0.075) or 0 to
doublets per thousand cells increment if doublet_rate is 0.
the number of CPU cores to use
sce a SingleCellExperiment object annotated for singlets
Remember to cite: - DoubletFinder: Doublet Detection in Single-Cell RNA Sequencing Data Using Artificial Nearest Neighbors. McGinnis CS, Murrow LM, Gartner ZJ. Cell Syst. 2019 Apr 24;8(4):329-337.e4. doi: https://doi.org/10.1016/j.cels.2019.03.003.
Other annotation functions:
.preprocess_seurat_object()
,
annotate_celltype_metrics()
,
annotate_integrated_sce()
,
annotate_merged_sce()
,
annotate_sce()
,
annotate_sce_cells()
,
annotate_sce_genes()
,
filter_sce()
,
find_cells()
,
find_singlets()
,
generate_sce()
,
map_ensembl_gene_id()
,
merge_sce()
,
read_metadata()
,
report_celltype_metrics()
,
report_celltype_model()
,
report_merged_sce()
,
report_qc_sce()
,
sce_to_seu()