R: Recast Matrix as Feature (Log-)Ratios

ratios {propr} | R Documentation

## Recast Matrix as Feature (Log-)Ratios

### Description

The `ratios` function recasts a matrix with N feature columns as a new matrix with N * (N - 1) / 2 feature (log-)ratio columns.

### Usage

    ratios(matrix, alpha = NA)

### Arguments

`matrix` | A matrix. The data to recast.
`alpha` | A double. See vignette for details. Leave missing to skip Box-Cox transformation.

### Details

When the `alpha` argument is provided, this function returns the (log-)ratios as `(partner^alpha - pair^alpha) / alpha`.

### Value

A matrix of (log-)ratios.

[Package propr version 4.2.6 Index]