summarize.regions,RnBSet-method {RnBeads} | R Documentation

## summarize.regions-methods

### Description

Summarize DNA methylation information for which is present in the `RnBSet` object.

### Usage

    ## S4 method for signature 'RnBSet'
    summarize.regions(
      object,
      region.type,
      aggregation = rnb.getOption("region.aggregation"),
      overwrite = TRUE
    )

### Arguments

`object` | Dataset of interest.
`region.type` | Type of the region annotation for which the summarization will be performed or `"strands"` for summarizing the methylation values from both strands
`aggregation` | Operation to summarize the methylation values. Currently supported values are `"mean"`, `"median"`, `"min"`, `"max"` and `"coverage.weighted"`
`overwrite` | If `TRUE` the existing region-level information for `region.type` is discarded

### Value

object of the same class as the supplied one containing the summarized methylation information for the specified region types

### Examples

    library(RnBeads.hg19)
    data(small.example.object)
    rnb.set.summarized<-summarize.regions(rnb.set.example, "genes", overwrite=TRUE)
    head(meth(rnb.set.summarized, type="genes", row.names=TRUE))

[Package RnBeads version 2.10.0 Index]