estimateSoup {SoupX}

Get expression profile of soup

Description

This is usually called by SoupChannel, rather than directly by the user. Uses the empty droplets in the range provided to calculate the expression profile of the soup under the assumption that these droplets only contain background.

Usage

estimateSoup(sc, soupRange = c(0, 100), keepDroplets = FALSE)

Arguments

sc

A SoupChannel object.

soupRange

Droplets with total UMI count in this range (excluding endpoints) are used to estimate soup.

keepDroplets

Storing the full table of counts for all droplets uses a lot of space and is really only used to estimate the soup profile. Therefore, it is dropped after the soup profile has been estimated unless this is set to TRUE.

Value

A modified version of sc with an extra soupProfile entry containing a data.frame with the soup profile and confidence limits for all genes.

Examples

#Load droplet and count tables
tod = Seurat::Read10X(system.file('extdata','toyData','raw_gene_bc_matrices','GRCh38',
                                  package='SoupX'))
toc = Seurat::Read10X(system.file('extdata','toyData','filtered_gene_bc_matrices','GRCh38',
                                  package='SoupX'))
#Suppress calculation of soup profile automatically on load
sc = SoupChannel(tod,toc,calcSoupProfile=FALSE)
#Retain table of droplets
sc = estimateSoup(sc,keepDroplets=TRUE)
#Or use non-default values
sc = estimateSoup(sc,soupRange=c(60,100))