R/CompareSce.R
compare_sce.Rd
This function takes a SingleCellExperiment object as an input, and compares gene sets over specified conditions/populations.
compare_sce(
sce_object,
assay_name = "logcounts",
group1 = NULL,
group1_population = NULL,
group2 = NULL,
group2_population = NULL,
pathways,
min_genes = 15,
max_genes = 500,
downsample = 500,
parallel = FALSE,
cores = NULL
)
SingleCellExperiment object with populations defined in the column data
Assay name to extract expression values from. Defaults to logcounts
First comparison group as defined by colData()
columns
of SingleCellExperiment object e.g. cell_type
Populations within group1 to compare e.g. c("t_cell", "b_cell")
Second comparison group as defined by colData()
columns
of SingleCellExperiment object e.g. hour
Population within group2 to compare e.g. 24
Pathway gene sets with each pathway in a separate list. For formatting of gene lists, see documentation at https://jackbibby1.github.io/SCPA/articles/using_gene_sets.html
Gene sets with fewer than this number of genes will be excluded
Gene sets with more than this number of genes will be excluded
Option to downsample cell numbers. Defaults to 500 cells per condition. If a population has < 500 cells, all cells from that condition are used.
Should parallel processing be used?
The number of cores used for parallel processing
Statistical results from the SCPA analysis. The qval should be the primary metric that is used to interpret pathway differences i.e. a higher qval translates to larger pathway differences between conditions. If only two samples are provided, a fold change (FC) enrichment score will also be calculated. The FC output is generated from a running sum of mean changes in gene expression from all genes of the pathway. It's calculated from average pathway expression in population1 - population2, so a negative FC means the pathway is higher in population2.