individual.based.pvalues.a {CNull}R Documentation

Produces the p-values of an alpha diversity measure f on a given matrix, based on the individual-based null model (Stegen et al. 2013)

Description

Given a matrix M and an alpha diversity measure f, the function calculates the p-values of f based on the individual-based null model.

Usage

individual.based.pvalues.a(matrix,f,args,reps=1000)

Arguments

matrix

A matrix with integer values. The matrix should not contain any NA values.

f

An alpha diversity function f. The interface of f should be such that f(matrix,args) returns a numeric vector V where the i-th element of V is equal to the value of f when applied at the i-th row of the given matrix. To fit to this interface, the user might have to develop f as a wrapper around an existing R function (see Examples).

args

A list with extra arguments needed by f.

reps

The number of randomizations. This argument is optional and its default value is set to one thousand.

Value

A numeric vector that stores the p-values of f, calculated based on the individual-based null model. The i-th element of the vector stores the p-value for the i-th row of the input matrix.

Author(s)

Constantinos Tsirogiannis (tsirogiannis.c@gmail.com)

References

Stegen, J. C., Freestone, A. L., Crist, T. O., Anderson, M. J., Chase, J. M., Comita, L. S., Cornell, H. V., Davies, K. F., Harrison, S. P., Hurlbert, A. H., Inouye, B. D., Kraft, N. J. B., Myers, J. A., Sanders, N. J., Swenson, N. G., Vellend, M. (2013), Stochastic and Deterministic Drivers of Spatial and Temporal Turnover in Breeding Bird Communities. Global Ecology and Biogeography, 22: 202-212.

Tsirogiannis, C., A. Kalvisa, B. Sandel and T. Conradi. Column-Shuffling Null Models Are Simpler Than You Thought. To appear.

See Also

individual.based.communities.a

Examples

#In the next example null-model calculations are
#performed using a function of phylogenetic diversity.
#Hence, we first load the required packages.
require(CNull)
require(ape)
require(PhyloMeasures)

#Load phylogenetic tree of bird families from package "ape"
data(bird.families, package = "ape")

#Create 100 random communities with 50 families each
comm = matrix(0,nrow = 100,ncol = length(bird.families$tip.label))
for(i in 1:nrow(comm)) {comm[i,sample(1:ncol(comm),50)] = 1}
colnames(comm) = bird.families$tip.label

#Set function f to be the Phylogenetic Diversity measure (PD)
#as defined in the R package PhyloMeasures.
my.f = function(mt,args){ return (pd.query(args[[1]],mt))}

# This function takes one extra argument, which is a phylogenetic tree.
# Hence, create a list whose only element is the desired tree.
arguments = list()
arguments[[1]] = bird.families

# Calculate the p-values of f for the communities in comm 
# based on the individual-based model, using 2000 Monte Carlo randomizations.
individual.based.pvalues.a(comm,f=my.f,args=arguments,reps=2000)

[Package CNull version 1.0 Index]