summary.findFn: Summary Method for findFn

Description

Summary Method for objects of class findFn

Usage

# S3 method for findFn
summary(object, minPackages = 12,
                         minCount = NA, ...)

Arguments

object

An object of class findFn

minPackages

the minimum number of packages to include in the summary. Other packages with the same count will also appear in the summmary, but packages with a smaller count will not.

The number of packages displayed will be less than minPackages only when there are fewer than that number of packages containing the search term in its help pages.

minCount

the minimum count for a package to display. minCount = 1 displays all packages. The default is the minimum of the input minCount and the count for package number minPackages.

…

ignored

Value

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

PackageSummary

a data.frame with one row for each package and columns Package, Count, MaxScore, TotalScore, Date, and pgLink. This summary is sorted per the sortby argument in the call to findFn.

minPackages, minCount

the minPackages and minCount arguments in this call to summary.findFn.

matches

the total number of matches returned by findFn. This is an attribute of a findFn object; the number of rows of object will either be matches or maxPages*matchesPerPage, whichever is smaller.

nrow

the number of matches in this findFn object

nPackages

the number of packages in this findFn object

call

the matched call to findFn.

Details

Return an object of class c('summary.findFn', 'list') with summary information on only packages satisfying the minPackages and minCount criteria. The minPackages and minCount components of the summary output list will be adjusted as necessary to match characteristics of object. The print method for a summary.findFn object will display the minCount, but minPackages will be a component of the returned object without being printed.

Examples

Run this code

# NOT RUN {
  z <- findFn("spline", maxPages = 2)
  summary(z, 2)
# }