sosInit: Rcmdr sos dialogues

In RcmdrPlugin.sos: Efficiently search the R help pages

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 [e-mail]

References

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

See Also

findFn, grepFn, unionFindFn,

RcmdrPlugin.sos documentation built on May 2, 2019, 5:48 p.m.