summary.Shannonci: Summary for Shannonci

Description Usage Arguments Value Examples

Description

Produces a detailed print out of the results of the function Shannonci.

Usage

1
2
## S3 method for class 'Shannonci'
summary(object, ...)

Arguments

object

An object of class "Shannonci", see Shannonci

...

further arguments to be passed to print, currently only digits

Value

A print out, comprising a table of the (possibly aggregated) data used for estimation, the sample estimates for the Shannon index with bias corrected and raw values, its variance estimates, the used contrast matrix, and the confidence intervals.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
data(HCD)

HCDcounts<-HCD[,-1]
HCDf<-HCD[,1]

# Comparison to the confidence bounds shown in
# Fritsch and Hsu (1999), Table 5, "Standard normal".

cmat<-rbind(
"HM-HU"=c(0,1,-1),
"HL-HM"=c(1,-1,0),
"HL-HU"=c(1,0,-1)
)

ShannonS<-Shannonci(X=HCDcounts, f=HCDf, type = "Sequen",
 alternative = "greater", conf.level = 0.9, dist = "N")

summary(ShannonS)


MCPAN documentation built on May 19, 2017, 9:24 a.m.
Search within the MCPAN package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.