ratios: Recast Matrix as Feature (Log-)Ratios

In tpq/propr: An R package to calculate proportionality and other measures for compositional data

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.

tpq/propr documentation built on Feb. 7, 2024, 9:19 a.m.