antclassify: AntClassify Full Ecological Pipeline

View source: R/antclassify.R

antclassifyR Documentation

AntClassify Full Ecological Pipeline

Description

Runs all ecological classification functions of the package.

Usage

antclassify(comm, verbose = TRUE, plot = TRUE, validate = TRUE, delay = 0.5)

Arguments

comm

Community matrix (samples x species). Species names as columns, samples as rows.

verbose

Logical; if TRUE, displays progress messages.

plot

Logical; if TRUE, displays guild proportion plots (passed to assign_guild_ants).

validate

Logical; if TRUE, validates species names using GBIF.

delay

Numeric; seconds between API calls (if validate = TRUE).

Value

A list containing results from all analyses (guilds, exotic, endemic, rarity).

Examples

## Not run: 
# Load the built-in example dataset
data(ant_community)

# Run the full pipeline (validation disabled for speed)
results <- antclassify(ant_community, validate = FALSE, plot = FALSE)

# Inspect the results
names(results)
head(results$guilds$table)
results$exotic$table
results$endemic$table
results$rarity$table

## End(Not run)

AntClassify documentation built on Sept. 4, 2026, 1:06 a.m.