gWidgets (version 0.0-27)

ghelp: Widget to interface with help pages

Description

A widget to interface with the help pages and that widget placed in a browser. The widget is a notebook capable of showing several pages at once.

Usage

ghelp(topic = NULL, package = NULL, container = NULL, ..., toolkit = guiToolkit())
ghelpbrowser(title = "Help browser", maxTerms=100, width=550, height=600, toolkit = guiToolkit())

Arguments

topic

Help topic

package

Which package to look for topic in

container

Optional container to attach widget to

title

Title of help browser

maxTerms

Maximum number of search responses

width

Width of browser window in pixels

height

Height of browser window in pixels

...

Passed to add method of container

toolkit

Which GUI toolkit to use

Details

Finding the help page can be a little slow.

The add(obj,value) method can be used to add a new page. The page may be specified as a list with components topic and package, as a string in the form package:::topic, or a string of the form topic.

Examples

obj <- ghelp(container=TRUE)
  add(obj,"base:::mean")