maxSignal: Accessor method for the 'maxSignal' slot in a...

maxSignalR Documentation

Accessor method for the maxSignal slot in a parameterOptions object.

Description

Accessor method for the maxSignal slot in a parameterOptions object.

Usage

maxSignal(object)

Arguments

object

object is a parameterOptions object.

Details

In the context of ChIPanalyser, maxSignal represents the maximum normalised ChIP-Seq signal of a given Transcription factor (or DNA binding protein). Although, A default value of 1 has been assigned to this slot, we strongly recommend to tailor this value accordingly. We strongly encourage to set values when building a parameterOptions object.

Value

Returns the value assigned to the maxSignal slot in a parameterOptions object.

Author(s)

Patrick C.N. Martin <p.martin@essex.ac.uk>

References

Zabet NR, Adryan B (2015) Estimating binding properties of transcription factors from genome-wide binding profiles. Nucleic Acids Res., 43, 84–94. Patrick C.N. Martin and Nicolae Radu Zabe (2020) Dissecting the binding mechanisms of transcription factors to DNA using a statistical thermodynamics framework. CSBJ, 18, 3590-3605.

Examples

# Building parameterOptions object
OPP <- parameterOptions()
#Setting new Value for maxSignal
maxSignal(OPP)


patrickCNMartin/ChIPanalyser documentation built on Nov. 24, 2022, 12:02 a.m.