STATegRa (version 1.0.0)

STATegRaUsersGuide: View STATegRa User's Guide

Description

Finds the location of the STATegRa User's Guide and optionally opens it.

Usage

STATegRaUsersGuide(view=TRUE)

Arguments

view

logical, if TRUE the document will be opened using the default PDF document reader?

Value

If view=TRUE, the PDF document reader is started and the User's Guide is opened, as a side effect.

Details

The function vignette("STATegRa") will find the short STATegRa Vignette which describes how to obtain the STATegRa User's Guide. The User's Guide is not itself a true vignette because it is not automatically generated using Sweave during the package build process. This means that it cannot be found using vignette, hence the need for this special function.

If the operating system is other than Windows, then the PDF viewer used is that given by Sys.getenv("R_PDFVIEWER"). The PDF viewer can be changed using Sys.putenv(R_PDFVIEWER=).

See Also

system

Examples

# To get the location:
STATegRaUsersGuide(view=FALSE)
# To open in pdf viewer:
## Not run: STATegRaUsersGuide()