maxSignal_-: Setter method for 'maxSignal' slot in a 'parameterOptions'...

maxSignal<-R Documentation

Setter method for maxSignal slot in a parameterOptions object.

Description

Setter method for maxSignal slot in a parameterOptions object.

Usage

maxSignal(object) <- value

Arguments

object

object is a parameterOptions object.

value

value is a numerical value to be assigned to the maxSignal slot.

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 a parameterOptions with an updated value for maxSignal.

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.

Examples

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


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