This function provides a unified wrapper to retrieve (log-)ratios
from propr
and propd
objects.
getRatios(object, cutoff = NA, include = NA, or = TRUE,
melt = FALSE)
A propr
or propd
object.
This argument indicates the value at which to
cutoff the results. For "rho" and "cor", the function
returns pairs with a value greater than the cutoff.
For "theta", "phi", and "phs", the function returns pairs
with a value less than the cutoff. Leave the argument as
NA
to return all results.
This argument indicates which features by
name should belong to a pair for that pair to get included
in the results. Subset performed by
Partner %in% subset | Pair %in% subset
.
A boolean. If FALSE
, include
subsets
by Partner %in% subset & Pair %in% subset
.
A boolean. Toggles whether to melt the results for
visualization with ggplot2
.
A data.frame
of (log-)ratios.
When the alpha
argument is provided, this function returns
the (log-)ratios as (partner^alpha - pair^alpha) / alpha
.