showHelp {PBSmodelling}R Documentation

Display Help Pages for Packages in HTML Browser

Description

Display the help pages for installed packages that match the supplied pattern in an HTML browser window.

Usage

showHelp(pat="methods")

Arguments

pat string pattern to match to package names

Details

The specified pattern is matched to R-packages installed on the user's system. The code uses the PBSmodelling function openFile to display the HTML Help Pages using a program that the system associates with html extensions. On systems that do not support file extension associations, the function setPBSext can temporarily set a command to associate with an extension.

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.

See Also

openFile, setPBSext, getPBSext


[Package PBSmodelling version 2.06 Index]