showHelp {PBSmodelling} | R Documentation |
Display HTML Help Pages for Packages in Browser
Description
Display the help pages for installed packages that match the supplied pattern in an HTML browser window.
Usage
showHelp(pattern="methods", ...)
Arguments
pattern |
string pattern to match to package names |
... |
allows user to specify two additional arguments: |
Details
The specified pattern is matched to R-packages installed on
the user's system. The code uses the utils
function browseURL
to display the HTML Help Pages using
a browser that the system associates with html
extensions. (See help for browseURL
for other operating systems.
Value
A list is invisibly returned, comprising:
Apacks |
all packages installed on user's system |
Spacks |
selected packages based on specified pattern |
URLs |
path and file name of HTML Help Page |
Help pages are displayed in a separate browser window.
Note
The connection time for browsers (at least in Windows OS)
is slow. If the HTML browser program is not already running,
multiple matching pages will most likely not be displayed. However,
subsequent calls to showHelp
should show all matches.
This function will now only work in R (>=3.2.0) or from SVN revision >= 67548.
The CRAN gurus now disallow direct calls to tools:::httpdPort
.
Author(s)
Rowan Haigh, Pacific Biological Station, Fisheries and Oceans Canada, Nanaimo BC