aldex.effect: Calculate effect sizes and differences between conditions

In ggloor/ALDEx_bioc: Analysis Of Differential Abundance Taking Sample and Scale Variation Into Account

Calculate effect sizes and differences between conditions

Description

Determines the median clr abundance of the feature in all samples and in groups. Determines the median difference between the two groups. Determines the median variation within each two group. Determines the effect size, which is the median of the ratio of the between-group difference and the larger of the variance within groups.

Usage

aldex.effect(
  clr,
  verbose = TRUE,
  include.sample.summary = FALSE,
  useMC = FALSE,
  CI = FALSE,
  glm.conds = NULL,
  paired.test = FALSE
)

Arguments

clr	clr is the data output of aldex.clr.
verbose	Print diagnostic information while running. Useful only for debugging if fails on large datasets.
include.sample.summary	Include median clr values for each sample, defaults to FALSE.
useMC	Use multicore by default (FALSE).
CI	Give effect 95% confidence intervals, defaults to FALSE.
glm.conds	Give effect for glm contrasts, note: saved as list.
paired.test	Calculate effect size for paired samples, defaults to FALSE.

Details

An explicit example for two conditions is shown in the 'Examples' below.

Value

Returns a dataframe with the following information:

rab.all	a vector containing the median clr value for each feature.
rab.win.conditionA	a vector containing the median clr value for each feature in condition A.
rab.win.conditionB	a vector containing the median clr value for each feature in condition B.
diff.btw	a vector containing the per-feature median difference between condition A and B.
diff.win	a vector containing the per-feature maximum median difference between Dirichlet instances within conditions.
effect	a vector containing the per-feature effect size.
overlap	a vector containing the per-feature proportion of effect size that is 0 or less.

Author(s)

Greg Gloor, Andrew Fernandes, Matt Links

References

Please use the citation given by citation(package="ALDEx").

See Also

aldex.clr, aldex.ttest, aldex.glm, aldex.glm.effect, selex

Examples

# x is the output of the \code{x <- clr(data, mc.samples)} function
# conditions is a description of the data
# for the selex dataset, conditions <- c(rep("N", 7), rep("S", 7))
data(selex)
# subset for efficiency
selex <- selex[1201:1600,]
conds <- c(rep("NS", 7), rep("S", 7))
x <- aldex.clr(selex, conds, mc.samples=2, denom="all")
effect.test <- aldex.effect(x)

ggloor/ALDEx_bioc documentation built on Oct. 31, 2023, 1:13 a.m.