RNAseqNetUsersGuide {RNAseqNet}

View RNAseqNet User's Guide

Description

Find the location of the RNAseqNet User's Guide and optionnaly opens it

Usage

RNAseqNetUsersGuide(html = TRUE, view = html)

Arguments

html

logical. Should the document returned by the function be the compiled PDF or the Rmd source. Default to TRUE

view

logical. Should the document be opened using the default HTML viewer? Default to html. It has no effect if html = FALSE

Details

The function vignette("RNAseqNet") will find the short RNAseqNet vignette that describes how to obtain the RNAseqNet User's Guide. The User's Guide is not itself a true vignette because it is not automatically generated during the package build process. However, the location of the Rmarkdown source is returned by the function if html = FALSE. If the operating system is not Windows, then the HTML viewer used is that given by Sys.getenv("R_BROWSER"). The HTML viewer can be changed using Sys.setenv(R_BROWSER = ).

Value

Character string giving the file location. If html = TRUE and view = TRUE, the HTML document reader is started and the User's Guide is opened in it.

Author(s)

Alyssa Imbert, [e-mail]

Nathalie Vialaneix, [e-mail]

Examples

RNAseqNetUsersGuide(view = FALSE)
RNAseqNetUsersGuide(html = FALSE)
## Not run: RNAseqNetUsersGuide()