WhistlerUsersGuide: View WhistleR User's Guide

In ZW-xjtlu/WhistleR: Comprehensive Annotation of Predictive Features for Interval-based Genomic Data

Description

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

Usage

WhistlerUsersGuide(view = TRUE)

Arguments

view	logical, should the document be opened using the default PDF document reader?

Details

The function vignette("WhistleR") will find the short WhistleR Vignette which describes how to obtain the WhistleR 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=).

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)

Zhen Wei

See Also

system

Examples

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

## End(Not run)

ZW-xjtlu/WhistleR documentation built on March 13, 2021, 10:50 a.m.