Zeta.sam.sensitivity {zetadiv} | R Documentation |
Sensitivity analysis for the sample size of zeta
Description
Computes zeta diversity for a given order (number of assemblages or sites) for a range of sample sizes, to assess the sensitivity to this parameter.
Usage
Zeta.sam.sensitivity(
data.spec,
xy = NULL,
order = 1,
sam.seq,
reps = 20,
sd.correct = TRUE,
sd.correct.adapt = FALSE,
rescale = FALSE,
normalize = FALSE,
NON = FALSE,
FPO = NULL,
DIR = FALSE,
display = TRUE,
plot = TRUE,
notch = TRUE
)
Arguments
data.spec |
Site-by-species presence-absence data frame, with sites as rows and species as columns. |
xy |
Site coordinates. This is only used if |
order |
Specific number of assemblages or sites at which zeta diversity is computed. |
sam.seq |
Sequence of samples for which the zeta diversity is computed. |
reps |
Number of replicates of zeta diversity computations for each sample size. |
sd.correct |
Boolean value (TRUE or FALSE) indicating if the standard deviation must be computed with an unbiased estimator (using the number of site combinations - 1 as the denominator) or not (using the number of site combinations as the denominator). |
sd.correct.adapt |
Boolean value (TRUE or FALSE) indicating if the standard deviation must be computed with an unbiased estimator (using the number of site combinations - 1 as the denominator) if |
rescale |
Boolean value (TRUE or FALSE) indicating if the zeta values should be divided by |
normalize |
Indicates if the zeta values for each sample should be divided by the total number of species for this specific sample ( |
NON |
Boolean value (TRUE or FALSE) indicating if the number of species in common should only be counted for the nearest neighbours. |
FPO |
A vector with the coordinates of the fixed point origin from which the zeta diversity will be computed (overrides NON). In that case, |
DIR |
Boolean value (TRUE or FALSE) indicating if zeta diversity must be computed using a directed nearest neighbour scheme in the direction away from the FPO, starting from any site. |
display |
Boolean value (TRUE or FALSE) indicating if the current value of the sample size must be displayed. Acts as a counter. |
plot |
Boolean value (TRUE or FALSE) indicating if the outputs must be plotted as a boxplot of the zeta diversity distributions for each sample size |
notch |
Boolean value (TRUE or FALSE) indicating if the notches must be plotted in the boxplot. |
Details
Note that the execution of Zeta.sam.sensitivity
can be quite lengthy, because of the number of replicates needed.
Value
Zeta.sam.sensitivity
returns a matrix with (sam.max-sam.min)/sam.incr
columns and reps
rows.
References
Hui C. & McGeoch M.A. (2014). Zeta diversity as a concept and metric that unifies incidence-based biodiversity patterns. The American Naturalist, 184, 684-694.
See Also
Zeta.decline.mc
, Zeta.order.mc
, Zeta.decline.ex
, Zeta.order.ex
Examples
#Note that the sensitivity analyses in the following two examples are quite long to run,
#typically around 10 minutes for the first example and 1-2 minutes for the second.
utils::data(bird.spec.coarse)
xy.bird <- bird.spec.coarse[1:2]
data.spec.bird <- bird.spec.coarse[3:193]
dev.new()
zeta.sens.bird <- Zeta.sam.sensitivity(data.spec.bird, order = 3,
sam.seq = seq(250,1000,250), reps = 20, display = TRUE, plot = TRUE, notch = TRUE)
zeta.sens.bird
##########
utils::data(Marion.species)
xy.marion <- Marion.species[1:2]
data.spec.marion <- Marion.species[3:33]
dev.new()
zeta.sens.marion <- Zeta.sam.sensitivity(data.spec.marion, order = 3,
sam.seq = seq(50,250,50), reps = 20, plot = TRUE, notch = TRUE)
zeta.sens.marion