summary.aldex: Summary Method for ALDEx3 Objects

View source: R/aldex-summary.R

summary.aldexR Documentation

Summary Method for ALDEx3 Objects

Description

Summarize an ALDEx3 result object

Usage

## S3 method for class 'aldex'
summary(object, ignore.intercept = TRUE, ...)

Arguments

object

An object of class aldex

ignore.intercept

(default=TRUE), ignore intercept when creating summary table

...

Additional arguments (currently ignored).

Details

Provides a summary of the adjusted p-values, estimates, and standard errors from an ALDEx3 result object.

This method extracts adjusted p-values from object$p.val.adj, along with posterior estimates and standard errors averaged across Monte Carlo samples. The result is returned as a long-format data.frame suitable for downstream analysis or visualization.

Value

A data.frame with columns parameter, entity, p.val.adjusted, estimate, and std.error.

Author(s)

Justin Silverman


ALDEx3 documentation built on Oct. 20, 2026, 1:07 a.m.