maSigProUsersGuide {maSigPro} | R Documentation

## View maSigPro User's Guide

### Description

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

### Usage

    maSigProUsersGuide(view=TRUE)

### Arguments

`view` | logical, to specify if the document is opened using the PDF document reader.

### Details

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

If `vignette(view=TRUE)`, the PDF document reader is started and the User's Guide is opened. If `vignette(view=FALSE)`, returns the file location.

### Examples

    maSigProUsersGuide()
    maSigProUsersGuide(view=FALSE)

[Package maSigPro version 1.54.0 Index]