relabundance {mia} | R Documentation

## Getter / setter for relative abundance data

### Description

`relabundance` is a getter/setter for relative abundance stored in the assay slot ‘relabundance’ of a `TreeSummarizedExperiment` object. This is a shortcut function for `assay(x,"relabundance")`.

### Usage

    relabundance(x, ...)

    relabundance(x) <- value

    ## S4 method for signature 'SummarizedExperiment'
    relabundance(x)

    ## S4 replacement method for signature 'SummarizedExperiment'
    relabundance(x) <- value

### Arguments

`x` | a `TreeSummarizedExperiment` object
`...` | optional arguments not used currently.
`value` | a `matrix` to store as the the ‘relabundance’ assay

### Value

For `relabundance` the matrix stored with the name “relabundance”.

### Examples

    data(GlobalPatterns)
    # Calculates relative abundances
    GlobalPatterns <- relAbundanceCounts(GlobalPatterns)
    # Fetches calculated relative abundances
    head(relabundance(GlobalPatterns))

[Package mia version 1.2.7 Index]