barrel_ord_summary: Summary Statistics for Ordination Objects

View source: R/8.barrel_ord_summary.R

barrel_ord_summaryR Documentation

Summary Statistics for Ordination Objects

Description

Computes adjusted R-squared and percentage of variance explained for constrained ordination methods (e.g., rda, cca, capscale, dbrda), or returns the stress value for non-metric multidimensional scaling (metaMDS).

Usage

barrel_ord_summary(ord)

Arguments

ord

An ordination object of class rda, cca, capscale, dbrda, or metaMDS.

Value

A named list with components:

method

Class of the ordination object as a character string.

R2_adj

Adjusted R-squared (percentage) for constrained ordinations; NA for NMDS.

axis_var

Named numeric vector of variance explained by each axis (percentage), if available.

stress

Stress value for NMDS objects.

message

Message explaining output, especially for NMDS or missing R2.

Examples

library(vegan)
data(dune)
data(dune.env)

# PCA (unconstrained ordination)
pca <- rda(dune)
barrel_ord_summary(pca)

# RDA (constrained ordination)
rda_mod <- rda(dune ~ A1 + Moisture, data = dune.env)
barrel_ord_summary(rda_mod)

# NMDS
nmds <- metaMDS(dune, k = 2)
barrel_ord_summary(nmds)

# dbRDA
dbrda_mod <- dbrda(dune ~ A1 + Management, data = dune.env, distance = "bray")
barrel_ord_summary(dbrda_mod)


barrel documentation built on Nov. 5, 2025, 7:40 p.m.