csawUsersGuide {csaw} | R Documentation |
Finds the location of the user's guide and opens it for viewing.
csawUsersGuide(view=TRUE)
view |
logical scalar specifying whether the document should be opened |
The csaw package is designed for de novo detection of differentially bound regions from ChIP-seq data. It provides methods for window-based counting, normalization, filtering and statistical analyses via edgeR. The user guide for this package can be obtained by running this function.
For non-Windows operating systems, the PDF viewer is taken from Sys.getenv("R_PDFVIEWER")
.
This can be changed to x
by using Sys.putenv(R_PDFVIEWER=x)
.
For Windows, the default viewer will be selected to open the file.
Note that the user's guide is not a true vignette as it is not generated using Sweave
when the package is built.
This is due to the time-consuming nature of the code when run on realistic case studies.
A character string giving the file location. If view=TRUE
, the
system's default PDF document reader is started and the user's guide is
opened.
Aaron Lun
# To get the location: csawUsersGuide(view=FALSE) # To open in pdf viewer: ## Not run: csawUsersGuide()