ratios: Recast Matrix as Feature (Log-)Ratios

Description Usage Arguments Details Value

View source: R/9-global.R

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

1
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.


propr documentation built on Dec. 16, 2019, 9:30 a.m.