maSigProUsersGuide: View maSigPro User's Guide

Description Usage Arguments Details Value Examples

Description

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

Usage

1

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

1
2

Example output

Loading required package: Biobase
Loading required package: BiocGenerics
Loading required package: parallel

Attaching package: 'BiocGenerics'

The following objects are masked from 'package:parallel':

    clusterApply, clusterApplyLB, clusterCall, clusterEvalQ,
    clusterExport, clusterMap, parApply, parCapply, parLapply,
    parLapplyLB, parRapply, parSapply, parSapplyLB

The following objects are masked from 'package:stats':

    IQR, mad, sd, var, xtabs

The following objects are masked from 'package:base':

    Filter, Find, Map, Position, Reduce, anyDuplicated, append,
    as.data.frame, cbind, colMeans, colSums, colnames, do.call,
    duplicated, eval, evalq, get, grep, grepl, intersect, is.unsorted,
    lapply, lengths, mapply, match, mget, order, paste, pmax, pmax.int,
    pmin, pmin.int, rank, rbind, rowMeans, rowSums, rownames, sapply,
    setdiff, sort, table, tapply, union, unique, unsplit, which,
    which.max, which.min

Welcome to Bioconductor

    Vignettes contain introductory material; view with
    'browseVignettes()'. To cite Bioconductor, see
    'citation("Biobase")', and for packages 'citation("pkgname")'.

Loading required package: MASS
[1] "/usr/local/lib/R/site-library/maSigPro/doc/maSigProUsersGuide.pdf"
[1] "/usr/local/lib/R/site-library/maSigPro/doc/maSigProUsersGuide.pdf"
sh: 0: Can't open /dev/null

maSigPro documentation built on Nov. 8, 2020, 6:51 p.m.