HTSClusterUsersGuide {HTSCluster} | R Documentation |
View HTSCluster User's Guide
Description
Finds the location of the HTSCluster User's Guide and optionally opens it.
Usage
HTSClusterUsersGuide(view=TRUE)
Arguments
view |
logical, should the document be opened using the default PDF document reader? |
Details
The function vignette("HTSCluster")
will find the short HTSCluster Vignette which describes how to obtain the HTSCluster 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=)
.
Note that this function was adapted from that defined by Gordon Smyth in the edgeR package.
Value
Character string giving the file location.
If view=TRUE
, the PDF document reader is started and the User's Guide is opened, as a side effect.
Author(s)
Gordon Smyth
See Also
Examples
# To get the location:
HTSClusterUsersGuide(view=FALSE)
# To open in pdf viewer:
## Not run: HTSClusterUsersGuide()