Embed Size (px)
Citation preview
Package ‘sos’July 3, 2017
Title Search Contributed R Packages, Sort by Package
Version 2.0-0
Author Spencer Graves, Sundar Dorai-Raj, and Romain Francois
Maintainer Spencer Graves <[email protected]>
Description Search contributed R packages, sort by package.
License GPL (>= 2)
Depends brew
Suggests RODBC, WriteXLS, fda
Repository CRAN
Repository/R-Forge/Project rsitesearch
Repository/R-Forge/Revision 265
Repository/R-Forge/DateTimeStamp 2017-07-03 07:45:41
Date/Publication 2017-07-03 13:38:22 UTC
NeedsCompilation no
R topics documented:back2ForwardSlash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Extract.findFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3findFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4grepFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7hits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8installPackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9packageSum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11PackageSum2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13PackageSummary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15print.findFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17print.packageSum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18sortFindFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19summary.findFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20unionFindFn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21writeFindFn2xls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
1
2 back2ForwardSlash
Index 25
back2ForwardSlash Replace backslash with forward slash in a character string
Description
scan a character string with backslash as the quote character and return it with backslashs replacedby forward slash.
NOTE: ’c:\User’ cannot be assigned to a character variable, because ’\U’ must be followed by ahexidecimal number, and ’s’ is not a legal hexidecimal digit. Therefore, we read the character stringof interest using scan rather than assigning it to a function argument.
Usage
back2ForwardSlash(nmax=1, what=character(), sep='\n', ...)
Arguments
nmax, what, sep, ...
arguments passed to scan
Details
It’s not easy to turn a back slash into a forward slash, because R interprets the back slash as anescape character. back2ForwardSlash tells R to read the next nmax lines, replacing ’\’ with ’/’.
Value
character vector with backslashes replaced by forward slashes.
Author(s)
Spencer Graves with help from Richard Cotton and Garrett See
See Also
scan gsub Quotes
Examples
(x <- back2ForwardSlash())#c:\users\
#NOTE: The "#" in this example is not needed.# It is included here to suppress a spurious warning# in the automated testing of the package via "R CMD check".
Extract.findFn 3
all.equal(x, '#c:/users/')
(x2. <- back2ForwardSlash(2))#c:\u\a b\n o#d:\pqr\
all.equal(x2., c('#c:/u/a b/n o', '#d:/pqr/'))
Extract.findFn Subset a findFn object
Description
Extract rows from a findFn object
Usage
## S3 method for class 'findFn'x[i, j,
drop = if (missing(i)) TRUE else length(cols) == 1]
Arguments
x An object of class findFn
i a valid object to select rows of x, e.g., a vector of all positive integers or allnegative integers between 1 and nrow(x) or a logical vector of length nrow(x).
j If not missing, the extraction function returns an object of class data.framerather than findFn.
drop logical: if FALSE and j selects only one column, return that column as a vector;else return a data.frame if j is present or a findFn object otherwise.
4 findFn
Details
1. if(missing(j)) extract the subset with the PackageSummary attribute recomputed on the subset.
2. else return(Extract.data.frame(x, i, j, drop))
Value
If j is missing, return an object of class c(’findFn’, ’data.frame’) else return whatever is returned byExtract.data.frame.
Author(s)
Spencer Graves
See Also
findFn, data.frame
Examples
z <- findFn("spline", maxPages = 2)
z1 <- z[1,]
z.2 <- z[, 2]
findFn Search Help Pages
Description
Returns a data.frame from RSiteSearch(string, "function") which can be sorted and subsettedby user specifications and viewed in an HTML table. The default sort puts first packages with themost matches (Count), with ties broken using the sum of the match scores for all the hits in thatpackage (TotalScore), etc.
Usage
findFn(string, maxPages = 20, sortby = NULL, verbose = 1, ...)
##???string(maxPages)
findFn 5
Arguments
string A character string. See RSiteSearch.
maxPages The maximum number of pages to download assuming 20 links per page.
sortby 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. Specifyingsortby = c(’c’, ’t’, ’m’) is equivalent to c(’Count’, ’TotalScore’, ’MaxScore’,’Package’, ’Score’, ’Function’).
verbose an integer: if 0, no output is printed to the console. The default 1 displays aninitial line with the number of pages to be retrieved and the number of matchesobtained; if the number of matches to be downloaded is less, this also is dis-played on the initial line. This is followed by a second line counting the pagesdownloaded.If greater than 1, additional information is provided on the download process.
... ignored
Details
findFn searchs the help pages of packages covered by the RSiteSearch archives. To restrict thesearch 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 amatrix PackageSummary.
3. Sort PackageSummary in the order defined by the occurrance of c(’Count’, ’MaxScore’, ’To-talScore’, ’Package’) in sortby.
4. Merge PackageSummary with the data.frame of search matches.
5. Sort the combined data.frame as defined by sort..
6. Make the result have class c("findFn", "data.frame") and add attributes matches, PackageSummary,string, and call.
7. Done.
Value
an object of class c(’findFn’, ’data.frame’) with columns and attributes as follows:
Columns • Count Total number of matches downloaded in this package• MaxScore maximum of the Score over all help pages selected within eachPackage. See Score below or the Namazu website (link below) for moreinformation on how the score is determined.
• TotalScore sum of the Score over all help pages selected within each Package.See Score below or the Namazu website (link below) for more informationon how the score is determined.
• Package Name of the package containing a help page meeting the searchcriteria
6 findFn
• Function Name of the help page found that meets the indicated search cri-terion.
• Date Date of the help page• Score Score returned by RSiteSearch, discussed in the Namazu website
(link below).• Description Title of the help page• Link Universal Resource Locator (URL) for the help page
Attributes • matches an integer = total number of matches found by the search. This typ-ically will exceed the number of rows found, because the search algorithmsometimes finds things that are not help pages for packages.
• PackageSummary a data.frame with one row for each package and columnsPackage, Count, MaxScore, TotalScore, and Date, sorted as in the sort.argument.
• string the string argument in the call.• callthe matched call
Author(s)
Spencer Graves, Sundar Dorai-Raj, Romain Francois. Duncan Murdoch suggested the "???" aliasfor "findFn" and contributed the code for it.
Special thanks to Jonathan Baron and Andy Liaw. Baron maintains the RSiteSearch data base. Liawand Baron created the RSiteSearch function in the utils package.
References
http://www.namazu.org/doc/tips.html.en#weight - reference on determining Score
See Also
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 gen-eral options. findFn searches only "Target: Functions" from that site, ignoring the R-help arcihves.
https://www.r-project.org/search.html for a list of alternative R search capabilities, each ofwhich may be best for different types of inquiries.
findFunction for a completely different function with a similar name.
Examples
# Skip these tests on CRAN,# because they take more than 5 secondsif(!fda::CRAN()){
z <- findFn("spline", maxPages = 2)# alternativezq <- ???spline(2)
all.equal(z, zq)
grepFn 7
# To search for 2 terms, not necessarily together:RSS <- findFn('RSiteSearch function', 1)matches(RSS)
# To search for an exact string, use braces:RSS. <- findFn('{RSiteSearch function}', 1)matches(RSS.) # list(nrow = 0, matches = 0)
# example in which resulting page has some unicode charactersLambert <- findFn("Lambert")Lambert#### Too many matches##fa <- findFn('factor analysis')# Finds too many matches to process;# reports Inf matches but returns none.# When this happens, use a more restrictive search
# checkfa0 <- RSS.[seq(1, length=0),]attr(fa0, 'matches') <- Infattr(fa0, 'PackageSummary') <- PackageSummary(fa0)attr(fa0, 'string') <- 'factor+analysis'attr(fa0, 'call') <- call('findFn', string = "factor analysis")
all.equal(fa, fa0)
}
grepFn Match pattern in a column of a matrix or data.frame
Description
Search for pattern in a column of a matrix or data.frame using grep. If value = TRUE (thedefault), return the selected subset of x.
Usage
grepFn(pattern, x, column='Function', ignore.case=FALSE,perl=FALSE, value=TRUE, fixed=FALSE,useBytes=FALSE, invert=FALSE)
8 hits
Arguments
x a matrix or data.frame containing a column named column.pattern, ignore.case, perl, fixed, useBytes, invert
as for grep
column character string giving the column of x in which to search for pattern.
value logical: If TRUE, return the selected subset of x. If FALSE, return the rownumbers returned by grep.
Details
1. g <- grep(pattern, x[, column])
2. if(value)return(x[g, ]) else return(g)
Value
If(value) return an object of the same class as x containing those rows of x with x[, column]matching pattern.
Else, return an integer vector identifying the rows of x with x[, column] matching pattern.
Author(s)
Spencer Graves, Sundar Dorai-Raj
See Also
findFn grep
Examples
z <- cbind(a=1:2, Function=c('s', 'spline'))z. <- grepFn("spline", z)
all.equal(z., z[2,,drop=FALSE])
hits matches attribute of a findFn object
Description
Returns the matches attribute of a findFn object. For the output of findFn, this is the number ofmatches for the search term. For a findFn object returned by unionFindFn or intersectFindFn,this is a numeric vector if the matches attributes of the arguments to unionFindFn or intersectFindFn.
installPackages 9
Usage
matches(x)hits(x)
Arguments
x object of class findFn.
Details
nrow(x) attr(x, ’matches’)
Value
a list with components nrows and matches
Author(s)
Spencer Graves
See Also
findFn unionFindFn intersectFindFn
Examples
des1 <- findFn('differential equations', 1)
des1. <- matches(des1)des. <- list(nrow=nrow(des1), matches=attr(des1, 'matches'))
all.equal(des1., des.)
installPackages install packages with minimum count
Description
Ensure that the most important packages in x are installed. "Importance" here is defined in thedescription of the minCount argument below.
10 installPackages
Usage
installPackages(x, minCount, ...)## S3 method for class 'findFn'installPackages(x, minCount, ...)## S3 method for class 'packageSum'installPackages(x, minCount,
repos = getOption("repos"), ...)
Arguments
x either a character vector to be passed to install.packages or a findFn or apackageSum object
minCount Controls how many of the packages identified in x to pass to install.packages.If x is a findFn or packageSum object, install every x[, 'Package'] withx[, 'Count'] >= minCount. By default, minCount = sqrt(x[1, 'Count']).
repos argument passed to install.packages
... optional arguments passed to install.packages
Details
Functions PackageSum2 and packageSum obtain some of the information displayed from installedpackages. To get more information in those summaries, run installPackages on a findFn orpackageSum object to install more of the packages found.
Value
none
Author(s)
Spencer Graves
See Also
install.packages PackageSum2
Examples
#### 1. findFn object##spl <- findFn("spline", maxPages = 2)# check the code but do not install anything:installPackages(spl, minCount=spl[1, 'Count']+1)
# default: install packages with# Count>=minCount
packageSum 11
## Not run:installPackages(spl)
## End(Not run)
#### 2. packageSum object##
splS <- packageSum(spl)# check the code but do not install anything:installPackages(splS, splS[1, 'Count']+1)
# install ALL packages## Not run:installPackages(splS, 1)
## End(Not run)
packageSum Add Info from Installed Packages to PackageSummary
Description
Obtain a summary by package of a findFn object give it class packageSum.
This is a simple function, first calling PackageSum2, than assigning class packagesum to it.
Usage
packageSum(x,fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
## S3 method for class 'findFn'packageSum(x,
fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
## S3 method for class 'data.frame'packageSum(x,
fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
## S3 method for class 'list'packageSum(x,
fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
12 packageSum
Arguments
x a data.frame with columns Package and Score.
fields character vector of names of columns to add to x. The function first looks in thecomponents of packageDescription(x$Package[i]). ’vignette’ is obtainedvia the function of that name.Component ’Packaged’ receives special treatment. If present, only the portionpreceding ’;’ will be retained. This seems to be a time stamp automaticallygenerated by something like R CMD build. It is absent for packages au-tomatically loaded when R is started. In such cases, the third component ofstrsplit(packageDescription( x$Package[i])$Built, ..., ';')will be stored as ’Packaged’. This seems to be a time stamp automatically gen-erated by something like R CMD INSTALL --build.
lib.loc an optional lib.loc argument passed to packageDescription.
... additional arguments (currently unused)
Details
With an object of class findFn, call PackageSum2, then make it class packageSum.
If less than half of the package reference are installed, it prints a note suggesting the user callinstallPackages, because much of the information is obtained from the packages’ DESCRIPTIONfile.
Value
a data.frame of class c(’packageSum’, ’data.frame’).
Author(s)
Spencer Graves
See Also
findFn PackageSum2 PackageSummary installPackages
Examples
#### data.frame method##tstdf <- data.frame(Package=c('grid', 'base'),
stringsAsFactors=FALSE)tst2 <- packageSum(tstdf)
#### list method##tstList <- list(PackageSummary=tstdf)
PackageSum2 13
all.equal(tst2, packageSum(tstList))
#### findFn method##tst.findFn <- data.frame(
Package=c('grid', 'base')[c(1,1,2)],Score=2:4, Date=LETTERS[1:3], stringsAsFactors=FALSE)
attr(tst.findFn, 'PackageSummary') <-PackageSummary(tst.findFn)
class(tst.findFn) <- c('findFn', 'data.frame')tst2. <- packageSum(tst.findFn)
all.equal(tst2, tst2.[names(tst2)])
#### spline example##splineHelp <- findFn("spline", maxPages = 2)splinePkgs <- packageSum(splineHelp)
PackageSum2 Add Info from Installed Packages to PackageSummary
Description
Add information on installed packages to the PackageSummary of a findFn object.
Usage
PackageSum2(x,fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
## S3 method for class 'findFn'PackageSum2(x,
fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
## S3 method for class 'data.frame'PackageSum2(x,
fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
## S3 method for class 'list'PackageSum2(x,
fields=c("Title", "Version", "Author", "Maintainer","Packaged", 'helpPages', 'vignette', 'URL'),lib.loc=NULL, ...)
14 PackageSum2
Arguments
x a data.frame with columns Package and Score.
fields character vector of names of columns to add to x. The function first looks in thecomponents of packageDescription(x$Package[i]). ’vignette’ is obtainedvia the function of that name.
Component ’Packaged’ receives special treatment. If present, only the portionpreceding ’;’ will be retained. This seems to be a time stamp automaticallygenerated by something like R CMD build. It is absent for packages au-tomatically loaded when R is started. In such cases, the third component ofstrsplit(packageDescription( x$Package[i])$Built, ..., ';')will be stored as ’Packaged’. This seems to be a time stamp automatically gen-erated by something like R CMD INSTALL --build.
lib.loc an optional lib.loc argument passed to packageDescription.
... additional arguments (currently unused)
Details
With an object of class findFn, extract the PackageSummary attribute and pass it to the data.framemethod.
With an object of class list, extract the PackageSummary component and pass it to the data.framemethod.
For a data.frame that is not an findFn object, add other columns from attributes of packageDescriptionfor installed packages named in the column Package. Also, for any packages that are installed, re-place the Date with the Packaged date. The Date in Baron’s RSiteSearch database is the date ofacquisition, which will typically be more recent than the Packaged date provided the locally in-stalled package has the same version as that in Baron’s database. To get the best information fromPackageSum2, it is wise to first run both installPackages to ensure that the packages of greatestinterest are installed locally and update.packages() to make sure you have the latest versionsinstalled locally. Similarly, if PackageSum2 does not contain complete interest on a package ofinterest, this can be fixed by installing the package and rerunning PackageSum2.
Value
a data.frame with additional fields columns appended to a PackageSummary data.frame.
Author(s)
Spencer Graves
See Also
packageSum, which does essentially the same thing but returns an object of class packageSum.findFn PackageSummary installPackages
PackageSummary 15
Examples
#### data.frame method##Tstdf <- data.frame(Package=c('grid', 'base'),
stringsAsFactors=FALSE)Tst2 <- PackageSum2(Tstdf)
#### list method##TstList <- list(PackageSummary=Tstdf)
all.equal(Tst2, PackageSum2(TstList))
#### findFn method##Tst.findFn <- data.frame(
Package=c('grid', 'base')[c(1,1,2)],Score=2:4, Date=LETTERS[1:3], stringsAsFactors=FALSE)
attr(Tst.findFn, 'PackageSummary') <- PackageSummary(Tst.findFn)
class(Tst.findFn) <- c('findFn', 'data.frame')Tst2. <- PackageSum2(Tst.findFn)
all.equal(Tst2, Tst2.[names(Tst2)])
PackageSummary Summarize findFn Results by Package
Description
Returns a data.frame with one row for each package and columns Count = number of rows in thesearch results for that package, maxScore and totalScore = max and total score for help pagesfound from that package.
Usage
PackageSummary(x, sortby=NULL)
Arguments
x a data.frame with columns Package, Score, and Date.
16 PackageSummary
sortby a character vector specifying how the data.frame returned should be sorted.Default = c(’Count’, ’MaxScore’, ’TotalScore’, ’Package’) to sort descendingon numerics and ascending on alphnumerics. Specifying sortby = c(’c’, ’t’,’m’) is equivalent to c(’Count’, ’TotalScore’, ’MaxScore’, ’Package’, ’Score’,’Function’).Components of sortby must match either this list or c(’Score’, ’Function’,’Date’, ’Description’, ’Link’). Any on this latter list are ignored without a warn-ing. This allows the same sortby used for findFn to be used here.
Details
1. Convert x[’Package] to character to automatically drop any unused levels of a factor.
2. Compute Count, TotalScore, and MaxScore.
3. Find the first occurrence of each Package, and use that to convert the Link to the first help page topkgLink = a link for the package. For example, the Link to ’html’ for help(’c’) is ’http://finzi.psych.upenn.edu/R/library/base/html/c.html’,and pkgLink to the ’html’ overview for ’base’ is ’http://finzi.psych.upenn.edu/R/library/base/html/00Index.html’.
4. Assemble into a data.frame, sort and return.
Value
a data.frame with one row for each package and columns Package, Count, MaxScore, TotalScore,Date, and pkgLink, sorted as specified by sortby.
Author(s)
Spencer Graves
See Also
RSiteSearch, findFn PackageSum2, packageSum
Examples
tstdf <- data.frame(Package=letters[c(1,1,2)], Score=2:4,Date=LETTERS[1:3], stringsAsFactors=FALSE)
tstdf$Link <- paste0('http://finzi.psych.upenn.edu/R/library/',tstdf$Package, '/html/', letters[4:6], '.html')
tstSum <- PackageSummary(tstdf)# The answer:tstSm <- data.frame(Package=letters[1:2], Count=c(a=2, b=1),
MaxScore=c(3, 4), TotalScore=c(5, 4),Date=LETTERS[c(1, 3)], stringsAsFactors=FALSE)
tstSm$pkgLink <- paste0('http://finzi.psych.upenn.edu/R/library/',tstdf$Package[2:3], '/html/00Index.html')
row.names(tstSm) <- 1:2
all.equal(tstSum, tstSm)
print.findFn 17
print.findFn print a findFn object
Description
Print a findFn object to a file and pass it to a web browser
Usage
## S3 method for class 'findFn'print(x, where, title,openBrowser = TRUE, template, ...)
Arguments
x An object of class findFn
where a character vector interpreted as follows:If length(where)==1, it must be either ’HTML’ or ’console’ or the name of acolum of x or the name of a file to hold the file created to be displayed in a webbrowser.If length(where)>1, it must be the names of columns of x to be displayed on theconsole. If where is a vector of names of columns of x, those columns will beprinted to the console, and there will be no display in a web browser. If where== ’console’, the following columns of x are displayed: c(’Count’, ’Package’,’Function’, ’Score’, ’Date’).
title An optional title to give the HTML file. Default is to use the original querystring.
openBrowser logical; if TRUE and where is missing or ’HTML’, launch default browser afterbuilding table
template Template file used by brew
... ignored
Value
The full path and name of the file created is returned invisibly.
Author(s)
Sundar Dorai-Raj, Spencer Graves, Romain Francois, Uwe Ligges
See Also
findFn, RSiteSearch, browseURL brew
18 print.packageSum
Examples
splineSearch <- findFn("spline", maxPages = 2)if(!fda::CRAN()){
print(splineSearch, 'console')splineSearch # all columns in a browser
}
print.packageSum print a packageSum object
Description
Print a packageSum object to a file and pass it to a web browser
Usage
## S3 method for class 'packageSum'print(x, where, title,
openBrowser = TRUE, template, ...)
Arguments
x An object of class packageSum
where a character vector interpreted as follows:If length(where)==1, it must be either ’HTML’ or ’console’ or the name of acolum of x or the name of a file to hold the file created to be displayed in a webbrowser.If length(where)>1, it must be the names of columns of x to be displayed on theconsole. If where is a vector of names of columns of x, those columns will beprinted to the console, and there will be no display in a web browser. If where== ’console’, the following columns of x are displayed: c(’Count’, ’maxScore’,’totalScore’, ’Package’, ’Date’).
title An optional title to give the HTML file. Default is to use the original querystring.
openBrowser logical; if TRUE and where is missing or ’HTML’, launch default browser afterbuilding table
template Template file used by brew
... ignored
Value
The full path and name of the file created is returned invisibly.
Author(s)
Spencer Graves
sortFindFn 19
See Also
print.findFn packageSum findFn, RSiteSearch, browseURL brew
Examples
splineHelp <- findFn("spline", maxPages = 2)splinePkgs <- packageSum(splineHelp)if(!fda::CRAN()){
print(splinePkgs, 'console')splinePkgs # all columns in a browser
}
sortFindFn Sort a findFn Object
Description
Sort a data.frame as a findFn object.
Usage
sortFindFn(x, sortby=NULL)
Arguments
x a data.frame to sort and convert to an object of class findFn (if it does notalreay have this class).
sortby sort information as for function findFn.
Details
1. pkgSum <- PackageSummary(x, sortby)
2. Order x as required for findFn
3. class = c("findFn", "data.frame")
Value
An object of class c(’findFn’, ’data.frame’) with a "PackageSummary" attribute.
Author(s)
Spencer Graves
See Also
findFn sort order
20 summary.findFn
Examples
tstdf <- data.frame(Package=letters[c(1,1,2)],Function=c('a1', 'a2', 'b3'), Score=2:4,Date=11:13, Description=c('D1', 'D2', 'D3'),Link=c('L1', 'L2', 'L3'), stringsAsFactors=FALSE)
rss <- sortFindFn(tstdf)
summary.findFn Summary Method for findFn
Description
Summary Method for objects of class findFn
Usage
## S3 method for class '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 packageswith the same count will also appear in the summmary, but packages with asmaller count will not.The number of packages displayed will be less than minPackages only whenthere are fewer than that number of packages containing the search term in itshelp pages.
minCount the minimum count for a package to display. minCount = 1 displays all pack-ages. The default is the minimum of the input minCount and the count forpackage number minPackages.
... ignored
Details
Return an object of class c(’summary.findFn’, ’list’) with summary information on only packagessatisfying the minPackages and minCount criteria. The minPackages and minCount componentsof the summary output list will be adjusted as necessary to match characteristics of object. Theprint method for a summary.findFn object will display the minCount, but minPackages will be acomponent of the returned object without being printed.
unionFindFn 21
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 thesortby 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 afindFn object; the number of rows of object will either be matches or max-Pages*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.
Author(s)
Spencer Graves
See Also
findFn, RSiteSearch
Examples
z <- findFn("spline", maxPages = 2)summary(z, 2)
unionFindFn Combine findFn Objects
Description
Combines to findFn objects into a new findFn object with only one row for any help page dupli-cated between the two. unionFindFn removes duplicate entries. intersectFindFn keeps only theduplicates.
Usage
unionFindFn(e1, e2, sortby=NULL)intersectFindFn(e1, e2, sortby=NULL)
## S3 method for class 'findFn'Ops(e1,e2)# This supports "|" for "unionFindFn"# and "&" for "intersectFindFn".
22 unionFindFn
Arguments
e1, e2 objects of class findFn.
sortby Optional sortby argument used by sortFindFn and findFn. Default is thesortby argument in attr(e1, 'call').
Details
1. e12 <- rbind(e1, e2)
2. For any (Package, Function) appearing in both e1 and e2, the row with the largest Score isretained and the other is deleted.
3. Apply sortFindFn to the rebuild the summary and sort the result as desired.
4. attr(e12, ’matches’) <- c(attr(e1, ’matches’), attr(e2, ’matches’))
Value
an object with class c(’findFn’, ’data.frame’) as returned by sortFindFn and findFn.
Note
Binary operators ‘&’ and ‘|’ are implemented for the S3 class ‘findFn’
Author(s)
Spencer Graves and Romain Francois
See Also
findFn sortFindFn
Examples
des1 <- findFn('differential equations', 1)de1 <- findFn('differential equation', 1)# each retrieves 1 page of 20 hits# but not the same 20
de.s <- unionFindFn(des1, de1)# combines the two, eliminating duplicates.
# or the sorter version:de.s. <- des1 | de1
all.equal(de.s, de.s.)
# Keep only the common entries.de2 <- intersectFindFn(des1, de1)
writeFindFn2xls 23
de2. <- des1 & de1
all.equal(de2, de2.)
# summary and print still work with the combined object.summary(de.s)if(!fda::CRAN()){
de.s}
summary(de2)if(!fda::CRAN()){
de2}
writeFindFn2xls Write a findFn object to an Excel file
Description
Write a findFn object to an Excel file with sheets for PackageSum2, the findFn table, and the callattribute of the findFn object.
Usage
writeFindFn2xls(x,file.=paste(deparse(substitute(x)), 'xls', sep='.'),csv, ...)
findFn2xls(x,file.=paste(deparse(substitute(x)), 'xls', sep='.'),csv, ...)
Arguments
x An object of class findFn
file. Name of Excel file to create. If a file of this name already exists, it will beoverwritten.
csv logical: if TRUE, write three *.csv files rather than one *.xls file. Default isFALSE if software is available to write a *.xls file and TRUE otherwise.
... optional arguments to write.csv used if
Details
findFn2xls is an alias for writeFindFn2xls; both functions do the same thing.
24 writeFindFn2xls
Value
The name of the file created is returned invisibly.
Author(s)
Spencer Graves with help from Dirk Eddedbuettel, Gabor Grothendiek, and Marc Schwartz.
See Also
findFn, odbcConnect, sqlSave, odbcClose
WriteXLS
Examples
splineSearch <- findFn("spline", maxPages = 1)
writeFindFn2xls(splineSearch)
findFn2xls(splineSearch, csv=TRUE)
Index
∗Topic manipback2ForwardSlash, 2
∗Topic methodsExtract.findFn, 3print.findFn, 17print.packageSum, 18sortFindFn, 19summary.findFn, 20
∗Topic miscfindFn, 4grepFn, 7hits, 8PackageSummary, 15unionFindFn, 21
∗Topic packageinstallPackages, 9packageSum, 11PackageSum2, 13
∗Topic printprint.findFn, 17print.packageSum, 18sortFindFn, 19summary.findFn, 20writeFindFn2xls, 23
? (findFn), 4??? (findFn), 4[.findFn (Extract.findFn), 3
back2ForwardSlash, 2brew, 17, 19browseURL, 17, 19
data.frame, 4, 14–16download.file, 6
Extract.findFn, 3
findFn, 4, 4, 8–10, 12, 14, 16, 17, 19, 21, 22,24
findFn2xls (writeFindFn2xls), 23
findFunction, 6
grep, 8grepFn, 7gsub, 2
help.search, 6hits, 8
install.packages, 10installPackages, 9, 12, 14intersectFindFn, 9intersectFindFn (unionFindFn), 21
matches (hits), 8
odbcClose, 24odbcConnect, 24Ops.findFn (unionFindFn), 21order, 19
packageSum, 10, 11, 14, 16, 19PackageSum2, 10–12, 13, 16, 23PackageSummary, 12, 14, 15print.findFn, 17, 19print.packageSum, 18print.summary.findFn (summary.findFn),
20
Quotes, 2
RSiteSearch, 4–6, 16, 17, 19, 21
scan, 2sort, 19sortFindFn, 19, 22sqlSave, 24summary.findFn, 20
unionFindFn, 9, 21
writeFindFn2xls, 23WriteXLS, 24
25
