PBSmodelling (version 2.68.8)

showHelp: 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", ...)

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.

Arguments

pattern

string pattern to match to package names

...

allows user to specify two additional arguments:
remote - character string giving a valid URL for the R_HOME directory on a remote location;
update - logical: if TRUE, attempt to update the package index to reflect the currently available packages. (Not attempted if remote is non-NULL.)

Author

Rowan Haigh, Pacific Biological Station, Fisheries and Oceans Canada, Nanaimo BC

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.

See Also

viewCode, showPacks