report_delim: Report Unique Species Partitions

In delimtools: Helper Functions for Species Delimitation Analysis

Report Unique Species Partitions

Description

report_delim() reports the number of unique species partitions in delim.

Usage

report_delim(delim, verbose = TRUE)

Arguments

delim	Output from any ⁠*_tbl()⁠ (e.g. gmyc_tbl), delim_join or delim_consensus.
verbose	Logical. If TRUE, returns a message and a tabulated summary of delim.

Details

For each column in delim, report_delim() will calculate the number of unique partitions and print them to Console. If delim is an output from ⁠*_tbl()⁠, report_delim() will get unique species partitions using vec_unique_count. If delim is an output from delim_join or delim_consensus, values are summarized by using n_distinct with na.rm = TRUE. This is to prevent any columns with NA values to be interpreted as species partitions.

Value

an object of class tbl_df].

Author(s)

Rupert A. Collins, Pedro S. Bittencourt

Examples

# report geophagus delimitations
report_delim(geophagus_delims)

delimtools documentation built on Nov. 5, 2025, 6:58 p.m.