Version: 0.3-0
Date: 2013-12-23
Title: Efficiently search the R help pages
Author: Liviu Andronic
Maintainer: Liviu Andronic <landronimirc@gmail.com>
Depends: sos (≥ 1.2-3)
Imports: Rcmdr (≥ 2.0-1), tcltk, tcltk2 (≥ 1.2-7)
Description: Rcmdr interface to the 'sos' package. The plug-in renders the 'sos' searching functionality easily accessible via the Rcmdr menus. It also simplifies the task of performing multiple searches and subsequently obtaining the union or the intersection of the results.
License: GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]
Packaged: 2013-12-23 18:24:17 UTC; liv
NeedsCompilation: no
Repository: CRAN
Date/Publication: 2013-12-24 07:37:36

Efficiently search R Help pages

Description

Rcmdr interface to sos

Details

The plug-in attempts to render the sos searching functionality readily accessible for casual use. It allows to perform simple searches (findFn) and more advanced operations such as filtering the search results (grepFn) or combining the results of multiple searches (unionFindFn, intersectFindFn).

For a good overview of the sos package see vignette("sos", package="sos").

Author(s)

Liviu Andronic landronimirc@gmail.com

See Also

Rcmdr, findFn, grepFn, unionFindFn,

Examples

## Not run: 
   ## start R
   library(RcmdrPlugin.sos)  ## loads Rcmdr and the plug-in

## End(Not run)

Rcmdr sos dialogues

Description

Rcmdr interface to findFn() and grepFn()

Usage

    sosInit()
    sosGrep(recall=NULL, bLabel=gettextRcmdr("Filter by"), 
    eLabel=gettextRcmdr("in"), 
    initialLabel=gettextRcmdr("Filter by"))

Arguments

recall

function to call after error.

bLabel, eLabel, initialLabel

strings defining the label of the grep button

Details

The dialogues provide the user with an interface to perform simple and more advanced searches of the R Help pages via the RSiteSearch functionality.

It is possible to perform multiple searches. One can specify up to 9 search terms separated either by "|" (vertical bars, to obtain the union of results) or "&" (ampersands, to obtain the intersection). One may use only one type of separating operator per search. For example, enter in the search box newey west | newey-west | neweywest or newey west & newey-west & neweywest, but not newey west | newey-west & neweywest.

Note that findFn() does not simply search for character strings. For example, findFn() may find less results for differential equation than for differential equations. In such cases you can perform multiple searches as described in the previous paragraph (differential equation | differential equations). For more on this issue see vignette("sos", package="sos").

Also note that findFn() performs the searches on-line, via Jonathan Baron's R Site Search [1]. Depending on how generic the search term is (for example, correlation) and the quality of the internet connection, it may take from a couple of seconds up to several minutes to complete the search and display the results.

Value

NULL

Author(s)

Liviu Andronic landronimirc@gmail.com

References

[1] http://finzi.psych.upenn.edu/nmz.html

See Also

findFn, grepFn, unionFindFn,