ASICSUsersGuide: View ASICS User's Guide

In GaelleLefort/ASICS: Automatic Statistical Identification in Complex Spectra

Description

Open the ASICS User's Guide (with default browser)

Usage

ASICSUsersGuide(view = TRUE)

Arguments

view	Logical. If TRUE, the user's guide will be opened with system default browser.

Details

The function vignette("ASICS") will find the short ASICS vignette that describes the main functions and how to obtain the ASICS User's Guide.
The User's Guide is not itself a true vignette because it is not automatically generated during the package build process.
If the operating system is not Windows, then the HTML viewer used is the one 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 view = TRUE, the HTML viewer is started and the User’s Guide is opened, as a side effect.

Examples

# To get the location
ASICSUsersGuide(view = FALSE)

# To open in a HTML viewer
## Not run: ASICSUsersGuide()

GaelleLefort/ASICS documentation built on July 19, 2020, 2:08 p.m.