ghelp {gWidgets}R Documentation

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.

This does not work with chm files on windows. However, the help browser in that environment is far superior than this, so no incentive exists to implement that.

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

The ghelpbrowser constructor produces a stand alone GUI for browsing help pages, running the corresponding examples and viewing a packages vignettes. Unlike other gWidgets constructors, this has no container argument.

Examples

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

## End(Not run)

[Package gWidgets version 0.0-35 Index]