rnb.execute.sex.removal {RnBeads} | R Documentation

## rnb.execute.sex.removal

### Description

Removes all sites in sex chromosomes from the given dataset.

### Usage

    rnb.execute.sex.removal(rnb.set)

### Arguments

`rnb.set` | Methylation dataset as an object of type inheriting `RnBSet`.

### Value

List of three elements:

`"dataset.before"`

  Copy of `rnb.set`.

`"dataset"`

  The (possibly) modified dataset after retaining sites on autosomes only.

`"filtered"`

  `integer` vector storing the indices (in beta matrix of the unfiltered dataset) of all removed probes.

### Author(s)

Yassen Assenov

### Examples

    library(RnBeads.hg19)
    data(small.example.object)
    rnb.set.filtered <- rnb.execute.sex.removal(rnb.set.example)$dataset
    identical(meth(rnb.set.example), meth(rnb.set.filtered)) # FALSE

[Package RnBeads version 2.10.0 Index]