CAGEr (version 1.14.0)

getShiftingPromoters: Selecting consensus clusters with shifting score above specified threshold

Description

Extracts consensus clusters with shifting score and/or FDR (adjusted P-value from Kolmogorov-Smirnov test) above specified threshold. Returns their genomic coordinates, total CAGE signal and the position of dominant TSS in the two compared groups of CAGE samples, along with the value of the shifting score, P-value and FDR. Scores and P-values/FDR have to be calculated beforehand by calling scoreShift function.

Usage

getShiftingPromoters(object, tpmThreshold = 0, scoreThreshold = -Inf, fdrThreshold = 1)

Arguments

object

A CAGEset object

tpmThreshold

Consensus clusters with total CAGE signal >= tpmThreshold in each of the compared groups will be returned.

scoreThreshold

Consensus clusters with shifting score >= scoreThreshold will be returned. The default value -Inf returns all consensus clusters (for which score could be calculated, i.e. the ones that have at least one tag in each of the comapred samples).

fdrThreshold

Consensus clusters with adjusted P-value (FDR) from Kolmogorov-Smirnov test >= fdrThreshold will be returned. The default value 1 returns all consensus clusters (for which K-S test could be performed, i.e. the ones that have at least one tag in each of the compared samples).

Value

Returns a data.frame of shifting promoters with genomic coordinates and positions of dominant TSS and CAGE signal in the two compared (groups of) samples, along with shifting score and adjusted P-value (FDR).

See Also

scoreShift

Examples

load(system.file("data", "exampleCAGEset.RData", package="CAGEr"))

shifting.promoters <- getShiftingPromoters(object = exampleCAGEset,
tpmThreshold = 100, scoreThreshold = 0.4, fdrThreshold = 0.01)
head(shifting.promoters)