new argument 'echo' (fixes #1126)

Author: eddelbuettel

R/Attributes.R

@@ -28,7 +28,8 @@ sourceCpp <- function(file = "",
                       showOutput = verbose,
                       verbose = getOption("verbose"),
                       dryRun = FALSE,
-                      windowsDebugDLL = FALSE) {
+                      windowsDebugDLL = FALSE,
+                      echo = TRUE) {
 
     # use an architecture/version specific subdirectory of the cacheDir
     # (since cached dynlibs can now perist across sessions we need to be
@@ -214,7 +215,7 @@ sourceCpp <- function(file = "",
     if (embeddedR && (length(context$embeddedR) > 0)) {
         srcConn <- textConnection(context$embeddedR)
         setwd(rWorkingDir) # will be reset by previous on.exit handler
-        source(file = srcConn, local = env, echo = TRUE)
+        source(file = srcConn, local = env, echo = echo)
     }
 
     # cleanup the cache dir if requested
@@ -258,7 +259,8 @@ cppFunction <- function(code,
                         rebuild = FALSE,
                         cacheDir = getOption("rcpp.cache.dir", tempdir()),
                         showOutput = verbose,
-                        verbose = getOption("verbose")) {
+                        verbose = getOption("verbose"),
+                        echo = TRUE) {
 
     # process depends
     if (!is.null(depends) && length(depends) > 0) {             # #nocov start
@@ -315,7 +317,8 @@ cppFunction <- function(code,
                           rebuild = rebuild,
                           cacheDir = cacheDir,
                           showOutput = showOutput,
-                          verbose = verbose)
+                          verbose = verbose,
+                          echo = echo)
 
     # verify that a single function was exported and return it
     if (length(exported$functions) == 0)

man/cppFunction.Rd

@@ -8,8 +8,8 @@ Dynamically define an R function with C++ source code. Compiles and links a shar
 }
 \usage{
 cppFunction(code, depends = character(), plugins = character(), includes = character(),
-            env = parent.frame(), rebuild = FALSE, cacheDir = getOption("rcpp.cache.dir", 
-            tempdir()), showOutput = verbose, verbose = getOption("verbose"))
+            env = parent.frame(), rebuild = FALSE, cacheDir = getOption("rcpp.cache.dir",
+            tempdir()), showOutput = verbose, verbose = getOption("verbose"), echo = TRUE)
 }
 
 \arguments{
@@ -39,11 +39,14 @@ cppFunction(code, depends = character(), plugins = character(), includes = chara
 }
   \item{verbose}{
     \code{TRUE} to print detailed information about generated code to the console.
+}
+  \item{echo}{
+    \code{TRUE} to silence output from optional R evaluation if set to \code{FALSE}.
 }
 }
 \details{
    Functions defined using \code{cppFunction} must have return types that are compatible with \code{Rcpp::wrap} and parameter types that are compatible with \code{Rcpp::as}.
-        
+
     The shared library will not be rebuilt if the underlying code has not changed since the last compilation.
 }
 \value{
@@ -63,36 +66,36 @@ cppFunction(code, depends = character(), plugins = character(), includes = chara
 
 cppFunction(
     'int fibonacci(const int x) {
-        if (x == 0) return(0); 
+        if (x == 0) return(0);
         if (x == 1) return(1);
         return (fibonacci(x - 1)) + fibonacci(x - 2);
     }')
 
 cppFunction(depends = "RcppArmadillo",
     'List fastLm(NumericVector yr, NumericMatrix Xr) {
-        
+
         int n = Xr.nrow(), k = Xr.ncol();
-        
-        arma::mat X(Xr.begin(), n, k, false); 
+
+        arma::mat X(Xr.begin(), n, k, false);
         arma::colvec y(yr.begin(), yr.size(), false);
-        
+
         arma::colvec coef = arma::solve(X, y);
         arma::colvec resid = y - X*coef;
-        
+
         double sig2 = arma::as_scalar(arma::trans(resid)*resid/(n-k) );
         arma::colvec stderrest = arma::sqrt(
             sig2 * arma::diagvec(arma::inv(arma::trans(X)*X)));
-        
+
         return List::create(Named("coefficients") = coef,
             Named("stderr")       = stderrest
         );
     }')
-    
+
 cppFunction(plugins=c("cpp11"), '
     int useCpp11() {
         auto x = 10;
         return x;
     }')
-    
+
 }
 }

man/sourceCpp.Rd

@@ -8,17 +8,17 @@ Source C++ Code from a File or String
 and RCPP_MODULE declarations. A shared library is then built and its exported functions and Rcpp modules are made available in the specified environment.
 }
 \usage{
-sourceCpp(file = "", code = NULL, env = globalenv(), embeddedR = TRUE, rebuild = FALSE, 
+sourceCpp(file = "", code = NULL, env = globalenv(), embeddedR = TRUE, rebuild = FALSE,
           cacheDir = getOption("rcpp.cache.dir", tempdir()), cleanupCacheDir = FALSE,
           showOutput = verbose, verbose = getOption("verbose"), dryRun = FALSE,
-          windowsDebugDLL = FALSE)
+          windowsDebugDLL = FALSE, echo = TRUE)
 }
 \arguments{
   \item{file}{
     A character string giving the path name of a file
 }
   \item{code}{
-    A character string with source code. If supplied, the code is taken from this string instead of a file. 
+    A character string with source code. If supplied, the code is taken from this string instead of a file.
 }
   \item{env}{
     Environment where the R functions and modules should be made available.
@@ -47,30 +47,33 @@ actually executing the commands).
 }
   \item{windowsDebugDLL}{
     \code{TRUE} to create a debug DLL on Windows (and ignored on other platforms).
+}
+  \item{echo}{
+    \code{TRUE} to silence output from optional R evaluation if set to \code{FALSE}.
 }
 }
 \details{
     If the \code{code} parameter is provided then the \code{file} parameter is ignored.
 
-    Functions exported using \code{sourceCpp} must meet several conditions, 
-    including being defined in the global namespace and having return types 
-    that are compatible with \code{Rcpp::wrap} and parameter types that are 
-    compatible with \code{Rcpp::as}. 
+    Functions exported using \code{sourceCpp} must meet several conditions,
+    including being defined in the global namespace and having return types
+    that are compatible with \code{Rcpp::wrap} and parameter types that are
+    compatible with \code{Rcpp::as}.
     See the \code{\link[=exportAttribute]{Rcpp::export}} documentation for more details.
-    
-    Content of Rcpp Modules will be automatically loaded into the specified 
-    environment using the \code{\link[=Module]{Module}} and 
-    \code{\link[=populate]{populate}} functions. 
-    
-    If the source file has compilation dependencies on other 
-    packages (e.g. \pkg{Matrix}, \pkg{RcppArmadillo}) then an 
-    \code{\link[=dependsAttribute]{Rcpp::depends}} attribute 
-    should be provided naming these dependencies. 
-    
-	It's possible to embed chunks of R code within a C++ source file by 
-	including the R code within a block comment with the 
+
+    Content of Rcpp Modules will be automatically loaded into the specified
+    environment using the \code{\link[=Module]{Module}} and
+    \code{\link[=populate]{populate}} functions.
+
+    If the source file has compilation dependencies on other
+    packages (e.g. \pkg{Matrix}, \pkg{RcppArmadillo}) then an
+    \code{\link[=dependsAttribute]{Rcpp::depends}} attribute
+    should be provided naming these dependencies.
+
+	It's possible to embed chunks of R code within a C++ source file by
+	including the R code within a block comment with the
 	prefix of \code{/*** R}. For example:
-    
+
 \preformatted{
 /*** R
 
@@ -80,11 +83,11 @@ fibonacci(10)
 */
 }
 
-	Multiple R code chunks can be included in a C++ file. R code is sourced after the C++ compilation is completed so all functions and modules will be available to the R code.   
+	Multiple R code chunks can be included in a C++ file. R code is sourced after the C++ compilation is completed so all functions and modules will be available to the R code.
 }
 
 \value{
-    Returns (invisibly) a list with two elements: 
+    Returns (invisibly) a list with two elements:
     \tabular{ll}{
         \code{functions} \tab Names of exported functions\cr
         \code{modules} \tab Names of Rcpp modules\cr
@@ -95,9 +98,9 @@ fibonacci(10)
 	The \code{sourceCpp} function will not rebuild the shared library if the source file has not changed since the last compilation.
 
     The \code{sourceCpp} function is designed for compiling a standalone source file whose only dependencies are R packages. If you are compiling more than one source file or have external dependencies then you should create an R package rather than using \code{sourceCpp}. Note that the \code{\link[=exportAttribute]{Rcpp::export}} attribute can also be used within packages via the \code{\link{compileAttributes}} function.
-    
+
     If you are sourcing a C++ file from within the \code{src} directory of a package then the package's \code{LinkingTo} dependencies, \code{inst/include}, and \code{src} directories are automatically included in the compilation.
-    
+
     If no \code{Rcpp::export} attributes or \code{RCPP_MODULE} declarations are found within the source file then a warning is printed to the console. You can disable this warning by setting the \code{rcpp.warnNoExports} option to \code{FALSE}.
 
 }