Calculate Mean Clade-Level Trait Distances Across Time Slices With Reach Criteria
clade_reach_distance.RdCalculate Mean Clade-Level Trait Distances Across Time Slices With Reach Criteria
Usage
clade_reach_distance(
df.TS.TE,
df.occ,
time.slice,
dist.trait,
nearest.taxon,
round.digits = 1,
species = "species",
TS = "TS",
TE = "TE",
lat = "lat",
lon = "lon",
Max.age = "Max.age",
Min.age = "Min.age",
crs = 4326,
remove.singletons = TRUE,
group = NULL,
group.focal.compare = NULL,
type.comparison = NULL
)Arguments
- df.TS.TE
A data frame containing species temporal data with at least three columns: species names, origination times (TS), and extinction times (TE). Additional columns may include group assignments.
- df.occ
data frame containing fossil occurrence records with at least five columns: species names, minimum age, maximum age, and latitude and longitude. Each row represents a single occurrence record at a specific site.
- time.slice
Numeric. The time interval (in the same units as TS and TE) between consecutive time slices for temporal binning.
- dist.trait
A distance matrix object (class
distormatrix) containing pairwise trait distances between species. Row and column names must match species names indf.TS.TE. If NULL, distances will be computed from the trait column using Euclidean distance.- nearest.taxon
Numeric or character. The number of nearest neighbors to consider when calculating mean distances. Use
1for mean nearest neighbor distance (MNND), or"all"for mean pairwise distance (MPD).- round.digits
Integer. The number of decimal places to round time slice values. Default is 1. This affects temporal binning precision.
- species
Character. The name of the column in
df.TS.TEanddf.occcontaining species identifiers. Default is "species".- TS
Character. The name of the column in
df.TS.TEcontaining origination (first appearance) times for each species. Default is "TS".- TE
Character. The name of the column in
df.TS.TEcontaining extinction (last appearance) times for each species. Default is "TE".- lat
Numeric. The latitude coordinate of the occurrence record in
df.occ.- lon
Numeric. The longitude coordinate of the occurrence records in
df.occ.- Max.age
Character. The name of the column in
df.occcontaining the maximum (oldest) age estimate for each occurrence record. Default is "Max.age".- Min.age
Character. The name of the column in
df.occcontaining the minimum (youngest) age estimate for each occurrence record. Default is "Min.age".- crs
Numeric. The code indicating the coordinate reference system to be used for latitude and longitude of occurrence records in
df.occ- remove.singletons
Logical. Should singleton species (species occurring alone at a site with no co-occurring species) be excluded from mean and variance calculations? Default is TRUE. When TRUE, singletons are treated as NA; when FALSE, they contribute 0 to the mean.
- group
Character. The name of the column in
df.TS.TEcontaining group assignments for species (e.g., clade, family). Required if usinggroup.focal.compare. Default is NULL.- group.focal.compare
Character vector of length 2. The first element specifies the focal group and the second specifies the comparison group. If NULL (default), coexistence is calculated across all species regardless of group membership.
- type.comparison
Character. Specifies the type of coexistence comparison:
"between": Count only co-occurrences between species from the focal and comparison groups."within": Count only co-occurrences among species within the focal group.NULL (default): Count all co-occurrences regardless of group.
- trait
Character. The name of the column in
df.TS.TEcontaining
Value
A data frame with three columns:
- mean.distance
Numeric. The mean distance among of co-occurring species in each time slice. This represents average mean distance in morphospace (excluding or including singletons based on
remove.singletons).- var.distance
Numeric. The variance in the mean distance in mophospace among species in each time slice.
- time.slice
Numeric. The time point representing each slice, typically the upper (older) boundary of the time bin.