[Rcpp-commits] r4002 - pkg/Rcpp/inst/doc/Rcpp-attributes

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

Author: jjallaire
Date: 2012-11-20 20:09:10 +0100 (Tue, 20 Nov 2012)
New Revision: 4002

Modified:
   pkg/Rcpp/inst/doc/Rcpp-attributes/Rcpp-attributes.Rnw
Log:
clarify language around benefits of packages

Modified: pkg/Rcpp/inst/doc/Rcpp-attributes/Rcpp-attributes.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-attributes/Rcpp-attributes.Rnw	2012-11-20 18:13:19 UTC (rev 4001)
+++ pkg/Rcpp/inst/doc/Rcpp-attributes/Rcpp-attributes.Rnw	2012-11-20 19:09:10 UTC (rev 4002)
@@ -490,15 +490,19 @@
 
 One of the goals of \pkg{Rcpp} attributes is to simultaneously facilitate
 ad-hoc and interactive work with \proglang{C++} while also making it very easy to
-migrate that work into an \proglang{R} package. Two major benefits of moving code
-from a standalone \proglang{C++} source file to a package are:
+migrate that work into an \proglang{R} package. There are several benefits of
+moving code from a standalone \proglang{C++} source file to a package:
 
 \begin{enumerate}
 \item
-  Users without \proglang{C++} development tools available can use your code.
+  Your code can be made availiable to users without \proglang{C++} development
+  tools (at least on Windows or Mac OS X where binary packages are common)
 \item
   Multiple source files and their dependencies are handled automatically
-  by the \proglang{R} package build system.
+  by the \proglang{R} package build system
+\item
+  Packages provide additional infrastructure for testing, documentation
+  and consistency
 \end{enumerate}
 
 To build a package that is based on \pkg{Rcpp} you should first follow the 
@@ -557,8 +561,6 @@
 attribute. For every package you import C++ code from (including \pkg{Rcpp}) 
 you need to add these entries.
 
-\pagebreak
-
 For example, if your package depends on \pkg{Rcpp} and \pkg{RcppArmadillo}
 you would have the following in your \texttt{DESCRIPTION} file: