[Rcpp-commits] r4337 - in pkg/Rcpp: . inst/doc/Rcpp-FAQ

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

Author: edd
Date: 2013-06-09 00:51:13 +0200 (Sun, 09 Jun 2013)
New Revision: 4337

Modified:
   pkg/Rcpp/ChangeLog
   pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw
Log:
some cross-referencing to Attributes


Modified: pkg/Rcpp/ChangeLog
===================================================================
--- pkg/Rcpp/ChangeLog	2013-06-08 22:12:54 UTC (rev 4336)
+++ pkg/Rcpp/ChangeLog	2013-06-08 22:51:13 UTC (rev 4337)
@@ -4,6 +4,7 @@
 
 	* inst/doc/Rcpp-introduction.Rnw: Added pointer to 'Rcpp Attributes'
 	vignette, as well as to 'Rcpp Sugar' and 'Rcpp Modules' vignettes.
+	* inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw: Idem
 
 2013-06-06  Romain Francois <romain at r-enthusiasts.com>
 
@@ -1513,7 +1514,7 @@
 	  This covered svn revisions 3264 to 3308.
 
 	* DESCRIPTION: Remove (for now) Depends: on int64
-	* inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw: Dito for int64_t example
+	* inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw: Ditto for int64_t example
 
 	* inst/unitTests/runit.Module.client.package.R: On Windows,
 	deactivate 'test.Module.package'

Modified: pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw	2013-06-08 22:12:54 UTC (rev 4336)
+++ pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw	2013-06-08 22:51:13 UTC (rev 4337)
@@ -72,7 +72,7 @@
 
 \subsection{How do I get started ?}
 
-Please execute the following command in \proglang{R}
+If you have \pkg{Rcpp} installed, please execute the following command in \proglang{R}
 
 <<eval=FALSE>>=
 vignette( "Rcpp-introduction" )
@@ -80,6 +80,9 @@
 
 \noindent to access the vignette which provides a detailed introduction.
 
+If you do not have \pkg{Rcpp} installed, the document should also be available
+whereever you found this document, \textsl{i.e.,} on every mirror of CRAN site.
+
 \subsection{What do I need ?}
 
 Obviously, \proglang{R} must be installed. \pkg{Rcpp} provides a
@@ -205,6 +208,8 @@
 The \texttt{verbose} argument of \Sexpr{link("cxxfunction")} is very
 useful as it shows how \pkg{inline} runs the show.
 
+Update: Also see question \ref{using-attributes} below about 'Rcpp
+Attributes' \citep{CRAN:Rcpp:Attributes}.
 
 \subsection{How do I convert my prototyped code to a package ?}
 \label{from-inline-to-package}
@@ -366,6 +371,17 @@
 CXXR and \pkg{Rcpp} both want \proglang{R} to make more use of \proglang{C++}
 but they do it in very different ways.
 
+\subsection{How do I quickly prototype my code using Attributes?}
+\label{using-attributes}
+
+\pkg{Rcpp} version 0.10.0 and later offer a new feature 'Rcpp Attributes'
+which is described in detail in its own vignette
+\citep{CRAN:Rcpp:Attributes}.  In short, it offers functions \code{evalCpp},
+\code{cppFunction} and \code{sourceCpp} which extend the functionality of the
+\code{cxxfunction} function.
+
+
+
 \section{Examples}
 
 The following questions were asked on the \texttt{rcpp-devel} mailing list,
@@ -404,6 +420,8 @@
 fun(2.2, 3L)
 @
 
+Update: Also see question \ref{using-attributes} above about 'Rcpp
+Attributes' \citep{CRAN:Rcpp:Attributes} and its \code{sourceCpp} function.
 
 \subsection{Can I do matrix algebra with \pkg{Rcpp} ?}