[Rcpp-commits] r230 - in pkg: inst inst/doc man

[noreply at r-forge.r-project.org]

Author: romain
Date: 2009-12-30 10:53:38 +0100 (Wed, 30 Dec 2009)
New Revision: 230

Added:
   pkg/man/RcppUnitTests.Rd
Modified:
   pkg/inst/ChangeLog
   pkg/inst/doc/
   pkg/inst/doc/Rcpp-unitTests.R
Log:
take advantage of the dynamic help system to show the unit test reports in a the RcppUnitTests Rd file

Modified: pkg/inst/ChangeLog
===================================================================
--- pkg/inst/ChangeLog	2009-12-30 08:42:44 UTC (rev 229)
+++ pkg/inst/ChangeLog	2009-12-30 09:53:38 UTC (rev 230)
@@ -1,3 +1,8 @@
+2009-12-30  Romain Francois <francoisromain at free.fr>
+
+	* man/RcppUnitTests.Rd: shows and link unit test reports generated at
+	build time
+
 2009-12-29  Romain Francois <francoisromain at free.fr>
 
 	* src/Rcpp_RObject.{h,cpp}: new namespace Rcpp and new class


Property changes on: pkg/inst/doc
___________________________________________________________________
Name: svn:ignore
   - RcppAPI.pdf
html
latex
man
Rcpp-unitTests.html
Rcpp-unitTests.pdf


   + RcppAPI.pdf
html
latex
man
Rcpp-unitTests.html
Rcpp-unitTests.pdf
Rcpp-unitTests.txt



Modified: pkg/inst/doc/Rcpp-unitTests.R
===================================================================
--- pkg/inst/doc/Rcpp-unitTests.R	2009-12-30 08:42:44 UTC (rev 229)
+++ pkg/inst/doc/Rcpp-unitTests.R	2009-12-30 09:53:38 UTC (rev 230)
@@ -23,4 +23,6 @@
 testSuite <- defineTestSuite(name=paste(pkg, "unit testing"), dirs = path)
 tests <- runTestSuite(testSuite)
 printHTMLProtocol(tests, fileName="Rcpp-unitTests.html" )
+printTextProtocol(tests, fileName="Rcpp-unitTests.txt" )
 
+

Added: pkg/man/RcppUnitTests.Rd
===================================================================
--- pkg/man/RcppUnitTests.Rd	                        (rev 0)
+++ pkg/man/RcppUnitTests.Rd	2009-12-30 09:53:38 UTC (rev 230)
@@ -0,0 +1,33 @@
+\name{RcppUnitTests}
+\alias{RcppUnitTests}
+
+\title{Rcpp : unit tests results}
+\description{
+Unit tests results for package Rcpp. 
+
+Unit tests are run automatically at build time and reports are included in the
+\samp{doc} directory as html or text. 
+}
+
+\seealso{
+\ifelse{html}{\url{../doc/Rcpp-unitTests.html}: html formatted unit test report}{\samp{../doc/Rcpp-unitTests.html}: html formatted unit test report}
+}
+
+\details{
+\ifelse{html}{\out{<pre>}}{\ifelse{latex}{\out{\begin{verbatim}}}{}}
+\Sexpr[echo=FALSE,results=text]{paste(readLines(system.file("doc", "Rcpp-unitTests.txt", package = "Rcpp" ) ), collapse="\n\n")}
+\ifelse{html}{\out{</pre>}}{\ifelse{latex}{\out{\end{verbatim}}}{}}
+}
+
+\examples{
+# unit tests are in the unitTests directory of the package
+list.files( system.file("unitTests", package = "Rcpp" ), 
+	pattern = "^runit", full = TRUE )
+
+# trigger the unit tests, follow printed instructions
+\dontrun{
+source( system.file("unitTests", "runTests.R", package = "Rcpp" ) )
+}
+}
+
+\keyword{programming}