\HeaderA{limmaUsersGuide}{View Limma User's Guide}{limmaUsersGuide}
\keyword{documentation}{limmaUsersGuide}
\begin{Description}\relax
Finds the location of the Limma User's Guide and optionally opens it.
\end{Description}
\begin{Usage}
\begin{verbatim}
limmaUsersGuide(view=TRUE)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{view}] logical, should the document be opened using the default PDF document reader?
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
The function \code{vignette("limma")} will find the short limma Vignette which describes how to obtain the Limma User's Guide.
The User's Guide is not itself a true vignette because it is not automatically generated using \code{\LinkA{Sweave}{Sweave}} during the package build process.
This means that it cannot be found using \code{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 \code{Sys.getenv("R\_PDFVIEWER")}.
The PDF viewer can be changed using \code{Sys.putenv(R\_PDFVIEWER=)}.

This function is used by drop-down Vignettes menu when the Rgui interface for Windows is used.
\end{Details}
\begin{Value}
Character string giving the file location.
\end{Value}
\begin{Author}\relax
Gordon Smyth
\end{Author}
\begin{SeeAlso}\relax
\code{\LinkA{vignette}{vignette}}, \code{\LinkA{openPDF}{openPDF}}, \code{\LinkA{openVignette}{openVignette}}, \code{\LinkA{Sys.getenv}{Sys.getenv}}, \code{\LinkA{Sys.putenv}{Sys.putenv}}
\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
limmaUsersGuide(view=FALSE)
\end{ExampleCode}
\end{Examples}

