searchEngines {svTools}

Various search engines for R documents

Description

Documentation about R is widespread and not always easy to find. These functions look for documents in various places.

Usage

searchBiblio(query, max = 30, url = "http://journal.r-project.org/RJournal.bib",
    add.bibRNews = TRUE, ...)
searchMailing(query, max = 30, groups = "*", prefix = "gmane.comp.lang.r")
searchGraph(query, max = 30)
searchPackage(query, max = 30)
searchWiki(query, max = 30)

## S3 method for class 'search'
print(x, detailed = TRUE, ...)
browse(object, ...)
## S3 method for class 'search'
browse(object, item = 1, ...)

Arguments

query

one or several topics to search for.

max

maximum number of items to return.

url

the url from where the BibTeX file describing R Jounal articles can be downloaded.

add.bibRNews

also add data for R News (local cached version)?

...

further arguments passed to the function or method.

groups

the mailing lists and newsgroups sections to search.

prefix

the gmane tree for the discussion archives.

x

a 'search' object.

detailed

do we print a detailled list of found items?

object

a 'search' object.

item

the index of the found item to browse.

Value

All the searchXXX() functions return a 'search' object that inherits from 'data.frame'. It contains the 'type' or search, the 'item' found, the 'page' in the item, a 'snippet' of the relevant text, a 'score' for this hit and the 'url' where the containt can be obtained.

The print() method presents the results in a more readable way, and one can browse() one item in the list.

Author(s)

Romain Francois <[e-mail]>

See Also

bibRNews, RSiteSearch

Examples

## Not run: 
searchBiblio("mean")
searchMailing("mean")
searchGraph("mean")
searchPackage("mean")
(res <- searchWiki("mean"))
browse(res, 1)  # Display the first item
rm(res)

## End(Not run)