Cell_qc: Quality control for single cell transcriptome.

View source: R/scLearn.R

Cell_qcR Documentation

Quality control for single cell transcriptome.

Description

scLearn evaluates the cell quality by three factors, i.e. the number of genes detected (default 500 to 10000), the number of unique molecular identifier induced (default above 1500), and the percentage of mitochondrial genes detected (default below 10% among all the detected genes). Only cells satified the whole three factors are retained.

Usage

Cell_qc(expression_profile, sample_information_cellType,sample_information_timePoint = NULL, species = "Hs", gene_low = 500, gene_high = 10000, mito_high = 0.1, umi_low = 1500, umi_high = Inf, logNormalize = TRUE, plot = FALSE, plot_path = "./quality_control.pdf")

Arguments

expression_profile

A dataframe showing the expression profile. The row is gene and The column is sample.

sample_information_cellType

A character vector showing the cell type of each sample. The column name of the vector is the sample name.

sample_information_timePoint

A character vector showing the time point of each sample. The column name of the vector is the sample name. The default is NULL.

species

The species the cells belong to. Currently species="Hs" for homo sapiens or species="Mm" for mus musculus are available. It is used to detect mitochondrial genes, so species doesn't matter if data won't be considered the percentage of mitochondrial genes.

gene_low

The minimun gene number for cells. Cells with genes below this threshold are filtered(default 500).

gene_high

The maximum gene number for cells. cells with genes above this threshold are filtered(default 10000).

mito_high

The maximum percentage of mitochondrial genes detected(default 10% among all the detected genes).

umi_low

The minimum number of unique molecular identifier induced (default 1500).

umi_high

The maximun number of unique molecular identifier induced (default Inf)

logNormalize

TRUE by default. If FALSE, the data will not be performed log normalized.

plot

FALSE by default. If TRUE, plot the graph.

plot_path

The path of the graph you plot. It works only when the parameter "plot" is TRUE.

Value

expression_profile

A dataframe showing expression profile after quality control.

sample_information_cellType

A character vector showing the cell type of each sample after quality control.

sample_information_timePoint

A character vector showing the time point of each sample after quality control if "sample_information_timePoint" is not NULL.

Author(s)

Bin Duan


bm2-lab/scLearn documentation built on Dec. 17, 2024, 8:18 p.m.