volatility: Compute volatility between pairs of microbiome count data

View source: R/volatility.R

volatilityR Documentation

Compute volatility between pairs of microbiome count data

Description

The main function of the volatility package.

Usage

volatility(counts, metadata, transform = TRUE, verbose = TRUE)

Arguments

counts

a microbiome count table, with rows as features and columns as samples

metadata

a vector in the same order as counts, containing information on which samples are from the same source and should be linked.

transform

a boolean, whether to CLR-transform count data beforehand. Highly recommended.

verbose

A boolean. Toggles whether to print diagnostic information while running. Useful for debugging errors on large datasets.

Value

a data.frame with IDs and volatility estimates per sample pair


thomazbastiaanssen/Volatility documentation built on July 13, 2024, 9:09 a.m.