check_exotic_ants: Identify Exotic Ant Species (Brazil)

View source: R/check_exotic_ants.R

check_exotic_antsR Documentation

Identify Exotic Ant Species (Brazil)

Description

Checks a community matrix for known exotic ant species in Brazil sourced from Vieira (2025).

Usage

check_exotic_ants(comm, verbose = TRUE, plot = TRUE)

Arguments

comm

A community matrix where species are columns and samples are rows.

verbose

Logical; if TRUE, displays progress messages.

plot

Logical; if TRUE, displays the plot of exotic vs. native proportions.

Value

Invisibly returns a list with two elements:

table

A data frame containing exotic species detected, with columns species, abundance, and percentage.

plot

A ggplot2 object showing the proportion of exotic vs. native species.

Examples

# Create a small example community matrix
species_list <- c(
  "Pachycondyla striata", "Pheidole megacephala", "Solenopsis saevissima",
  "Paratrechina longicornis", "Wasmannia auropunctata"
)
set.seed(123)
comm_data <- matrix(
  rpois(length(species_list) * 3, lambda = 2),
  nrow = 3,
  ncol = length(species_list),
  dimnames = list(paste0("sample", 1:3), species_list)
)
result <- check_exotic_ants(comm_data, verbose = FALSE, plot = FALSE)
head(result$table)

AntClassify documentation built on April 9, 2026, 9:08 a.m.