iNextPD: iNterpolation and EXTrapolation of Hill number

Description Usage Arguments Value Examples

View source: R/iNextPD.R

Description

iNextPD: Interpolation and extrapolation of Hill number with order q.

Usage

1
2
iNextPD(x, labels, phy, q = 0, datatype = "abundance", size = NULL,
  endpoint = NULL, knots = 40, se = FALSE, conf = 0.95, nboot = 50)

Arguments

x

a matrix, data.frame (species by sites), or list of species abundances or incidence data.

labels

species names for object x.

phy

a phylog objcet for input phylo-tree.

q

a numeric value specifying the diversity order of Hill number .

datatype

data type of input data: individual-based abundance data (datatype = "abundance"), or species by sampling-units incidence matrix (datatype = "incidence_raw").

size

an integer vector of sample sizes (number of individuals or sampling units) for which diversity estimates will be computed. If NULL, then diversity estimates will be computed for those sample sizes determined by the specified/default endpoint and knots .

endpoint

an integer specifying the sample size that is the endpoint for rarefaction/extrapolation. If NULL, then endpoint = double reference sample size.

knots

an integer specifying the number of equally-spaced knots (say K, default is 40) between size 1 and the endpoint; each knot represents a particular sample size for which diversity estimate will be calculated. If the endpoint is smaller than the reference sample size, then iNextPD() computes only the rarefaction esimates for approximately K evenly spaced knots. If the endpoint is larger than the reference sample size, then iNextPD() computes rarefaction estimates for approximately K/2 evenly spaced knots between sample size 1 and the reference sample size, and computes extrapolation estimates for approximately K/2 evenly spaced knots between the reference sample size and the endpoint.

se

a logical variable to calculate the bootstrap standard error and conf confidence interval.

conf

a positive number < 1 specifying the level of confidence interval, default is 0.95.

nboot

an integer specifying the number of replications.

Value

a list of three objects: $DataInfo for summarizing data information; $iNextPDEst for showing diversity estimates for rarefied and extrapolated samples along with related statistics; $AsyPDEst for showing asymptotic diversity estimates along with related statistics, and $ExpandData (xi, Li, i=1,2,...,B).

Examples

1
2
3
4
5
data(bird)
bird.abu <- bird$abun
bird.lab <- rownames(bird$abun)
bird.phy <- ade4::newick2phylog(bird$tre)
iNextPD(bird.abu, labels=bird.lab, phy=bird.phy, q=0, datatype="abundance")

iNextPD documentation built on May 2, 2019, 3:31 a.m.