coseqUsersGuide: View coseq User's Guide

In coseq: Co-Expression Analysis of Sequencing Data

Description

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

Usage

coseqUsersGuide(view = TRUE)

Arguments

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

Details

The function vignette("coseq") will find the short coseq Vignette which describes how to obtain the coseq 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 not Windows, the PDF viewer used is 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

system

Examples

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

coseq documentation built on May 2, 2019, 4:55 p.m.