summary.RSiteSearch: Summary Method for RSiteSearch

In RSiteSearch: RSiteSearch

Description

Summary Method for RSiteSearch

Usage

## S3 method for class 'RSiteSearch'
summary(object, threshold = 1, ...)

Arguments

object	An object of class RSiteSearch
threshold	The minimum number of hits for a package to print. Default of 1 shows all packages.
...	ignored

Details

1. Identify all packages with at least threshold hits.

2. Return an object of class c('summary.RSiteSearch', 'list') with summary information.

Value

An object of class c('summary.RSiteSearch', 'list') with the following elements:

PackageSummary	a data.frame with one row for each package and columns Package, Count, MaxScore, TotalScore, and Date. This summary is sorted per the sort. argument in the call to RSiteSearch.function.
threshold	the threshold argument in this call to summary.RSiteSearch.
hits	the total number of hits returned by RSiteSearch. This is an attribute of an RSiteSearch object; the number of rows of object will either be hits or maxPages*matchesPerPage, whichever is smaller.
nrow	the number if hits actually returned by RSiteSearch.function.
call	the matched call to RSiteSearch.function.

Author(s)

Spencer Graves

See Also

RSiteSearch.function, RSiteSearch

Examples

  z <- RSiteSearch.function("spline", maxPages = 2)
  summary(z, 2)

RSiteSearch documentation built on May 2, 2019, 5:45 p.m.