[Swift-commit] r5250 - in SwiftApps/SwiftR/Swift: . R man
tga at ci.uchicago.edu
tga at ci.uchicago.edu
Thu Oct 20 18:32:21 CDT 2011
Author: tga
Date: 2011-10-20 18:32:20 -0500 (Thu, 20 Oct 2011)
New Revision: 5250
Added:
SwiftApps/SwiftR/Swift/man/swiftTests.Rd
Modified:
SwiftApps/SwiftR/Swift/NAMESPACE
SwiftApps/SwiftR/Swift/R/Tests.R
SwiftApps/SwiftR/Swift/man/Swift-package.Rd
SwiftApps/SwiftR/Swift/man/swiftExport.Rd
SwiftApps/SwiftR/Swift/man/swiftInit.Rd
SwiftApps/SwiftR/Swift/man/swiftLibrary.Rd
SwiftApps/SwiftR/Swift/man/swiftapply.Rd
Log:
Fix documentation and visibility of runAllSwiftTests to conform with CRAN
Modified: SwiftApps/SwiftR/Swift/NAMESPACE
===================================================================
--- SwiftApps/SwiftR/Swift/NAMESPACE 2011-10-19 20:11:19 UTC (rev 5249)
+++ SwiftApps/SwiftR/Swift/NAMESPACE 2011-10-20 23:32:20 UTC (rev 5250)
@@ -12,3 +12,5 @@
export(swiftExportAll)
export(swiftRemoveAll)
+export(basicSwiftTest)
+export(runAllSwiftTests)
Modified: SwiftApps/SwiftR/Swift/R/Tests.R
===================================================================
--- SwiftApps/SwiftR/Swift/R/Tests.R 2011-10-19 20:11:19 UTC (rev 5249)
+++ SwiftApps/SwiftR/Swift/R/Tests.R 2011-10-20 23:32:20 UTC (rev 5250)
@@ -21,8 +21,9 @@
basicSwiftTest <- function(...) {
swiftInit(...)
- swiftTest_1.1()
+ testRes <- swiftTest_1.1()
swiftShutdown()
+ return (invisible(testRes))
}
swiftTest_1.1 <- function() {
@@ -800,12 +801,13 @@
startTime = proc.time()[["elapsed"]]
- runTestSuite(makeFullTestSuite(...))
+ testRes <- runTestSuite(makeFullTestSuite(...))
endTime <- proc.time()[["elapsed"]]
runTime <- endTime - startTime
cat("\n\n ===> Total elapsed test time = ",runTime," seconds.\n\n")
+ return (invisible(testRes))
}
Modified: SwiftApps/SwiftR/Swift/man/Swift-package.Rd
===================================================================
--- SwiftApps/SwiftR/Swift/man/Swift-package.Rd 2011-10-19 20:11:19 UTC (rev 5249)
+++ SwiftApps/SwiftR/Swift/man/Swift-package.Rd 2011-10-20 23:32:20 UTC (rev 5250)
@@ -479,6 +479,7 @@
\code{\link{swiftapply}}
\code{\link{swiftLibrary}}
\code{\link{swiftExport}}
+\code{\link{runAllSwiftTests}}
}
\examples{
library(Swift)
Modified: SwiftApps/SwiftR/Swift/man/swiftExport.Rd
===================================================================
--- SwiftApps/SwiftR/Swift/man/swiftExport.Rd 2011-10-19 20:11:19 UTC (rev 5249)
+++ SwiftApps/SwiftR/Swift/man/swiftExport.Rd 2011-10-20 23:32:20 UTC (rev 5250)
@@ -88,7 +88,7 @@
%% ~Make other sections like Warning with \section{Warning }{....} ~
\seealso{
-\code{\link{Swift-package}}
+\code{\link{Swift}}
}
\examples{
Modified: SwiftApps/SwiftR/Swift/man/swiftInit.Rd
===================================================================
--- SwiftApps/SwiftR/Swift/man/swiftInit.Rd 2011-10-19 20:11:19 UTC (rev 5249)
+++ SwiftApps/SwiftR/Swift/man/swiftInit.Rd 2011-10-20 23:32:20 UTC (rev 5250)
@@ -157,7 +157,7 @@
\seealso{
%% ~~objects to See Also as \code{\link{help}}, ~~~
-\code{\link{Swift-package}}
+\code{\link{Swift}}
\code{\link{swiftShutdown}}
}
\examples{
Modified: SwiftApps/SwiftR/Swift/man/swiftLibrary.Rd
===================================================================
--- SwiftApps/SwiftR/Swift/man/swiftLibrary.Rd 2011-10-19 20:11:19 UTC (rev 5249)
+++ SwiftApps/SwiftR/Swift/man/swiftLibrary.Rd 2011-10-20 23:32:20 UTC (rev 5250)
@@ -61,7 +61,7 @@
\seealso{
%% ~~objects to See Also as \code{\link{help}}, ~~~
-\code{\link{Swift-package}}
+\code{\link{Swift}}
}
\examples{
library(Swift)
Added: SwiftApps/SwiftR/Swift/man/swiftTests.Rd
===================================================================
--- SwiftApps/SwiftR/Swift/man/swiftTests.Rd (rev 0)
+++ SwiftApps/SwiftR/Swift/man/swiftTests.Rd 2011-10-20 23:32:20 UTC (rev 5250)
@@ -0,0 +1,58 @@
+\name{swiftTests}
+\alias{runAllSwiftTests}
+\alias{basicSwiftTest}
+%- Also NEED an '\alias' for EACH other topic documented here.
+\title{
+Swift Test Suite
+}
+\description{
+These functions run automated tests for the Swift package.
+}
+\usage{
+runAllSwiftTests(...)
+basicSwiftTest(...)
+}
+%- maybe also 'usage' for other objects documented here.
+\arguments{
+ \item{\dots}{
+ Any arguments to be passed to \code{swiftInit} when starting up a
+ test cluster.
+}
+}
+\details{
+ Run the SwiftR test suite and report on successes and failures.
+ \code{basicSwiftTest} runs a single test as a sanity check for
+ the system. \code{runAllSwiftTests} tests a broader range of
+ SwiftR functionality.
+}
+\value{
+ \code{runAllSwiftTests} returns a data structure describing the results of the test suite.
+ \code{basicSwiftTest} returns a boolean value, TRUE if the test was successful.
+ In the event of some failures the test suite may hang.
+}
+\references{
+\url{http://www.ci.uchicago.edu/swift}
+}
+\author{
+Swift was developed by: Mihael Hategan, Ben Clifford, Justin Wozniak,
+Yong Zhao, Ian Foster, and Michael Wilde with contributions from Sarah
+Kenny, Ioan Raicu, Luiz Gadelha, Allan Espinosa, Zhao Zhang, David
+Kelly, Jon Monette, Glen Hocky, Tom Uram, Wenjun Wu, and other users.
+
+Swift R package developed by Michael Wilde, Tim Armstrong and the OpenMx project
+
+Maintainer: Michael Wilde <wilde at mcs.anl.gov>
+}
+
+\seealso{
+\code{\link{swiftInit}}
+\code{\link{Swift}}
+}
+\examples{
+library(Swift)
+runAllSwiftTests()
+\dontrun{runAllSwiftTests(server="local", cores=4)}
+\dontrun{runAllSwiftTests(server="ssh", cores=4,
+ hosts=c("larry.example.com", "moe.example.com", "curly.example.com"))}
+\dontrun{basicSwiftTest(server="pbsauto", nodes=4, cores=8, time="00:30:00")}
+}
Modified: SwiftApps/SwiftR/Swift/man/swiftapply.Rd
===================================================================
--- SwiftApps/SwiftR/Swift/man/swiftapply.Rd 2011-10-19 20:11:19 UTC (rev 5249)
+++ SwiftApps/SwiftR/Swift/man/swiftapply.Rd 2011-10-20 23:32:20 UTC (rev 5250)
@@ -143,7 +143,7 @@
\seealso{
%% ~~objects to See Also as \code{\link{help}}, ~~~
\code{\link{swiftInit}}
-\code{\link{Swift-package}}
+\code{\link{Swift}}
}
\examples{
\dontshow{library(Swift)}
More information about the Swift-commit
mailing list