RSiteSearch.function {RSiteSearch} | R Documentation |
Returns a data.frame from
RSiteSearch(string, "function")
which can be
sorted and subsetted by user specifications and viewed in an HTML
table.
RSiteSearch.function(string, maxPages = 10, sort.=NULL, quiet = FALSE, ...)
string |
A character string. See
RSiteSearch . |
maxPages |
The maximum number of pages to download assuming 20 links per page. |
sort. |
a character vector specifying how the data.frame returned
should be sorted. Default = c('Count', 'MaxScore', 'TotalScore',
'Package', 'Score', 'Function') to sort descending on numerics and
ascending on alphnumerics. Specifying sort. = c('c', 't', 'm')
is equivalent to c('Count', 'TotalScore', 'MaxScore', 'Package',
'Score', 'Function').
|
quiet |
logical; if TRUE no output is printed to the console. The
default FALSE displays a progress report with each page of
matches.
|
... |
ignored |
RSiteSearch.function
searchs the help pages of packages covered
by the RSiteSearch
archives. To restrict the search to only
packages installed locally, use help.search
.
1. Access the RSitSearch
engine with string
,
restricting to "functions", storing Score
, Package
,
Function
, Date
, Description
, and Link
in a
data.frame
.
2. Compute Count
, MaxScore
and TotalScore
for
each Package
accessed. Combine them in a matrix
PackageSummary
.
3. Sort PackageSummary
in the order defined by the occurrance
of c('Count', 'MaxScore', 'TotalScore', 'Package') in sort.
.
4. Merge PackageSummary
with the data.frame
of search
hits.
5. Sort the combined data.frame
as defined by sort.
.
6. Make the result have class c("RSiteSearch", "data.frame") and add
attributes hits
, summary
, and call
.
7. Done.
an object with class c('RSiteSearch', 'data.frame') with columns and attributes as follows:
Columns |
|
Attributes |
|
Spencer Graves and Sundar Dorai-Raj
http://www.namazu.org/doc/tips.html.en#weight - reference on
determining Score
help.search
to search only installed packages.
RSiteSearch
,
download.file
http://finzi.psych.upenn.edu/search.html for a web interface to
this same search capability with more general options. This function
searches only "Target: Functions" from that site, ignoring the R-help
arcihves.
http://www.r-project.org/search.html for a list of alternative R search capabilities, each of which may be best for different types of inquiries.
z <- RSiteSearch.function("spline", maxPages = 2) str(z) # To search for 2 terms, not necessarily together: RSS <- RSiteSearch.function('RSiteSearch function', 1) str(RSS) # To search for an exact string, use braces: RSS. <- RSiteSearch.function('{RSiteSearch function}', 1)