getRatios: Get (Log-)ratios from Object

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

Get (Log-)ratios from Object

Description

This function provides a unified wrapper to retrieve (log-)ratios from propr and propd objects.

Usage

getRatios(object, switch = TRUE)

Arguments

object	A propr or propd object.
switch	A boolean. For propd, toggles whether all ratios should have same orientation with respect to log-ratio means.

Details

When the propd object is made using alpha, this function returns the (log-)ratios as (partner^alpha - pair^alpha) / alpha.

Value

A data.frame of (log-)ratios.

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