vegandocs: Display Package Documentation

In pattakosn/Rworkshop: Community Ecology Package

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 using R command news as news(package = "vegan").

• ONEWS: old news about vegan version 1.* 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: a vignette demonstrating a simple, standard ordination analysis. This can be also read using vignette("intro-vegan", package="vegan").

• diversity-vegan: a vignette describing (most) diversity analyses in vegan. This can be also read using vignette("diversity-vegan", package="vegan").

• decision-vegan: a vignette discussing design decisions in vegan. 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 in varpart.

• permutations: a vignette in the permute package giving an introduction to restricted permutation schemes. You can also read this using vignette("permutations", package="permute").

Note

Function vignette only works with vignettes processed by R, but the current function also shows other pdf documents. You can extract R code from vignettes, but not from other documents (see Examples).

The permutations.pdf document is in the permute package.

Author(s)

Jari Oksanen

See Also

vignette, news.

Examples

## Not run: 
## 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)
##

## End(Not run)

pattakosn/Rworkshop documentation built on May 24, 2019, 8:22 p.m.