plot.diversity_test: Plot the result of a diversity test (alpha or gamma)

Description Usage Arguments Note See Also

View source: R/diversityTests-divtable.R

Description

Plot an object of class diversity_test, the result of alphaDiversityTest, alphaContrastTest, alphaContrastTest3, gammaContrastTest and gammaContrastTest3.

Usage

1
2
3
4
5
## S3 method for class 'diversity_test'
plot(x, breaks = 50, compress.x = TRUE,
  compress.ratio = 1.2, xlab = "ln(LR) value", ylab = "Frequency",
  main = x$method, legend.text = "Observed ln(LR) = ",
  digits = getOption("digits"), ...)

Arguments

x

Object of class diversity_test, returned by alphaDiversityTest, alphaContrastTest, alphaContrastTest3, gammaContrastTest and gammaContrastTest3

breaks

Number of breaks to use when plotting the histogram of the empirical distribution, passed to hist(..., plot = FALSE)

compress.x

Logical, if TRUE and the observed value is more than compress.ratio times the maximum value of the empirical distribution, the x-axis is compressed to include the observed value

xlab, ylab, main

Labels added to the plot

legend.text

Text to use when printing legend containing the observed value in the upper right of the plot. Set to NULL to suppress printing the legend.

digits

Number of significant digits to use when printing numeric values

compress.ration

See compress.x

Note

The method used to compress the x-axis when observed values greatly exceed the empirical distribution has not been well thought through.

See Also

alphaDiversityTest, alphaContrastTest, alphaContrastTest3, gammaContrastTest, gammaContrastTest3


douglasgscofield/dispersalDiversity documentation built on March 30, 2021, 9:50 a.m.