R: Summary for Shannonci

summary.Shannonci {MCPAN} | R Documentation

## Summary for Shannonci

### Description

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

### Usage

    ## 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

    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)

[Package MCPAN version 1.1-21 Index]