Description Usage Arguments Details Value Constructor Accessors Utilities Author(s) See Also Examples
This class holds preprocessed data for Illumina methylation microarrays.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | ## Constructor
MethylSet(Meth = new("matrix"), Unmeth = new("matrix"),
annotation = "", preprocessMethod = "", ...)
## Data extraction / Accessors
## S4 method for signature 'MethylSet'
getMeth(object)
## S4 method for signature 'MethylSet'
getUnmeth(object)
## S4 method for signature 'MethylSet'
getBeta(object, type = "", offset = 0, betaThreshold = 0)
## S4 method for signature 'MethylSet'
getM(object, type = "", ...)
## S4 method for signature 'MethylSet'
getCN(object, ...)
## S4 method for signature 'MethylSet'
getManifest(object)
## S4 method for signature 'MethylSet'
preprocessMethod(object)
## S4 method for signature 'MethylSet'
annotation(object)
## S4 method for signature 'MethylSet'
pData(object)
## S4 method for signature 'MethylSet'
sampleNames(object)
## S4 method for signature 'MethylSet'
featureNames(object)
## Utilities
dropMethylationLoci(object, dropRS = TRUE, dropCH = TRUE)
|
object |
A |
Meth |
A matrix of methylation values (between zero and infinity) with each row being a methylation loci and each column a sample. |
Unmeth |
See the |
annotation |
An annotation string, optional. |
preprocessMethod |
A |
type |
How are the values calculated? For |
offset |
Offset in the beta ratio, see detail. |
betaThreshold |
Constrains the beta values to be in the inverval
betwen |
dropRS |
Should SNP probes be dropped? |
dropCH |
Should CH probes be dropped |
... |
For the constructor, additional arguments to be passed to
|
This class inherits from eSet
. Essentially the class is a representation of a
Meth
matrix and a Unmeth
matrix linked to a pData
data frame.
In addition, an annotation and a preprocessMethod slot is present. The annotation slot describes the type of array and also which annotation package to use. The preprocessMethod slot describes the kind of preprocessing that resulted in this dataset.
A MethylSet
stores meth
and Unmeth
. From these it is easy to compute Beta
values, defined as
Beta = Meth / (Meth + Unmeth + offset)
The offset is chosen to avoid dividing with small values. Illumina uses a default of 100. M-values (an unfortunate bad name) are defined as
M = logit(Beta) = log( Meth / Unmeth )
This formula has problems if either Meth or Unmeth is zero. For this reason, we can use
betaThreshold
to make sure Beta is neither 0 nor 1, before taken the logit. What makes
sense for the offset
and betaThreshold
depends crucially on how the data was
preprocessed. Do not expect the default values to be particular good.
An object of class MethylSet
for the constructor.
Instances are constructed using the MethylSet
function with the
arguments outlined above.
In the following code, object
is a MethylSet
.
getMeth(object)
, getUnmeth(object)
Get the Meth or the Unmeth matrix
getBeta(object)
Get Beta, see details.
getM(object)
get M-values, see details.
getCN(object)
get copy number values which are defined as the sum of the methylation and unmethylation channel.
getManifest(object)
get the manifest associated with the object.
preprocessMethod(object)
Get the preprocess method character
.
In the following code, object
is a MethylSet
.
dropMethylationLoci
(object)A unifed interface to removing methylation loci. You can drop SNP probes (probes that measure SNPs, not probes containing SNPs) or CH probes (non-CpG methylation).
combine
:Combines two different MethylSet
,
eventually using the combine
method for eSet
.
Kasper Daniel Hansen khansen@jhsph.edu
eSet
for the basic class structure.
Objects of this class are typically created from an
RGChannelSet
using preprocessRaw
or
another preprocessing function.
1 | showClass("MethylSet")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.