vegan (version 2.0-10)

vegandocs: Display Package Documentation

Description

Display NEWS, vignettes, other special documents or ChangeLog in vegan, or vignettes in permute.

Usage

vegandocs(doc = c("NEWS", "ONEWS", "ChangeLog", "FAQ-vegan.pdf",
    "intro-vegan.pdf", "diversity-vegan.pdf", "decision-vegan.pdf",
    "partitioning.pdf", "permutations.pdf"))

Arguments

doc

The name of the document (partial match, case sensitive).

Details

You can read the following documents with this function:

• NEWS: most important new functions, features, fixes etc. from the user's point of view. These can be also read usingRcommandnewsasnews(package = "vegan").
• ONEWS: old news aboutveganversion1.*before September 2011.
• ChangeLog: similar to news, but intended for developers wit more fine grained comments on internal changes.
• FAQ-vegan: Frequently Asked Questions. Consult here before writing to Mail groups.
• intro-vegan: avignettedemonstrating a simple, standard ordination analysis. This can be also read usingvignette("intro-vegan", package="vegan").
• diversity-vegan: avignettedescribing (most) diversity analyses invegan. This can be also read usingvignette("diversity-vegan", package="vegan").
• decision-vegan: avignettediscussing design decisions invegan. Currently this discusses implementing nestedness temperature (nestedtemp), backtracking algorithm in community null models (commsimulator), scaling of RDA results, and why WA scores are used as default instead of LC scores in constrained ordination.
• partitioning: Detailed description of variation partitioning schemes used invarpart.
• permutations: avignettein thepermutepackage giving an introduction to restricted permutation schemes. You can also read this usingvignette("permutations", package="permute").

See Also

vignette, news.

Examples

## Read NEWS
vegandocs()
## Alternatively (perhaps with different formatting)
news(package="vegan")
## Read a vignette
vegandocs("intro")
## with vignette()
vignette("intro-vegan", package="vegan")
## extract R code
vig <- vignette("intro-vegan", package="vegan")
edit(vig)
##