Description Usage Arguments Details Value Author(s) See Also Examples
View source: R/edgeRUsersGuide.R
Finds the location of the edgeR User's Guide and optionally opens it.
1 | edgeRUsersGuide(view=TRUE)
|
view |
logical, should the document be opened using the default PDF document reader? |
The function vignette("edgeR")
will find the short edgeR Vignette which describes how to obtain the edgeR 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=)
.
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.
Gordon Smyth
1 2 3 4 | # To get the location:
edgeRUsersGuide(view=FALSE)
# To open in pdf viewer:
## Not run: edgeRUsersGuide()
|
Loading required package: limma
[1] "/usr/lib/R/site-library/edgeR/doc/edgeRUsersGuide.pdf"
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.