[Rcpp-commits] r2994 - in pkg/Rcpp/inst/doc: Rcpp-FAQ Rcpp-extending Rcpp-modules Rcpp-package Rcpp-sugar

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

Author: edd
Date: 2011-04-12 04:24:57 +0200 (Tue, 12 Apr 2011)
New Revision: 2994

Modified:
   pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw
   pkg/Rcpp/inst/doc/Rcpp-extending/Rcpp-extending.Rnw
   pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw
   pkg/Rcpp/inst/doc/Rcpp-package/Rcpp-package.Rnw
   pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw
Log:
added JSS paper citation to vignettes per Achim's suggestion/request


Modified: pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw	2011-04-12 02:19:06 UTC (rev 2993)
+++ pkg/Rcpp/inst/doc/Rcpp-FAQ/Rcpp-FAQ.Rnw	2011-04-12 02:24:57 UTC (rev 2994)
@@ -94,7 +94,7 @@
 
 \abstract{
   \noindent This document attempts to answer the most Frequently Asked
-  Questions (FAQ) regarding the \pkg{Rcpp} \citep{CRAN:Rcpp} package.
+  Questions (FAQ) regarding the \pkg{Rcpp} \citep{CRAN:Rcpp,JSS:Rcpp} package.
 }
 
 \section{Getting started}

Modified: pkg/Rcpp/inst/doc/Rcpp-extending/Rcpp-extending.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-extending/Rcpp-extending.Rnw	2011-04-12 02:19:06 UTC (rev 2993)
+++ pkg/Rcpp/inst/doc/Rcpp-extending/Rcpp-extending.Rnw	2011-04-12 02:24:57 UTC (rev 2994)
@@ -93,7 +93,7 @@
 \abstract{
   \noindent
   This note provides an overview of the steps programmers should follow to
-  extend \pkg{Rcpp} \citep{CRAN:Rcpp} for use with their own classes. This document
+  extend \pkg{Rcpp} \citep{CRAN:Rcpp,JSS:Rcpp} for use with their own classes. This document
   is based on our experience in extending \pkg{Rcpp} to work with the
   \pkg{Armadillo} \citep{Sanderson:2010:Armadillo} classes, available in the separate package
   \pkg{RcppArmadillo} \citep{CRAN:RcppArmadillo}. This document assumes

Modified: pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw	2011-04-12 02:19:06 UTC (rev 2993)
+++ pkg/Rcpp/inst/doc/Rcpp-modules/Rcpp-modules.Rnw	2011-04-12 02:24:57 UTC (rev 2994)
@@ -66,11 +66,11 @@
 
 Exposing \proglang{C++} functionality to \proglang{R} is greatly facilitated
 by the \pkg{Rcpp} package and its underlying \proglang{C++} library
-\citep{CRAN:Rcpp}. \pkg{Rcpp} smoothes many of the rough edges in
+\citep{CRAN:Rcpp,JSS:Rcpp}. \pkg{Rcpp} smoothes many of the rough edges in
 \proglang{R} and \proglang{C++} integration by replacing the traditional
 \proglang{R} Application Programming Interface (API) described in
 `\textsl{Writing R Extensions}' \citep{R:Extensions} with a consistent set of \proglang{C++}
-classes. The `\textsl{Rcpp-introduction}' vignette \citep{CRAN:Rcpp} describes the API and
+classes. The `\textsl{Rcpp-introduction}' vignette \citep{CRAN:Rcpp,JSS:Rcpp} describes the API and
 provides an introduction to using \pkg{Rcpp}.
 
 These \pkg{Rcpp} facilities offer a lot of assistance to the programmer
@@ -1097,7 +1097,7 @@
 
 The simplest way to load all functions and classes from a module directly
 into a package namespace is to use the \Sexpr{link("loadRcppModules" )} function
-within the \Sexpr{link(".onLoad" )} body. 
+within the \Sexpr{link(".onLoad" )} body.
 
 <<eval=FALSE>>=
 .onLoad <- function(libname, pkgname) {
@@ -1106,8 +1106,8 @@
 @
 
 This will look in the package's DESCRIPTION file for the \texttt{RcppModules}
-field, load each declared module and populate their contents into the 
-package's namespace. For example, the \pkg{testRcppModule} 
+field, load each declared module and populate their contents into the
+package's namespace. For example, the \pkg{testRcppModule}
 (part of \pkg{Rcpp}'s testing) package has this declaration:
 
 \begin{verbatim}

Modified: pkg/Rcpp/inst/doc/Rcpp-package/Rcpp-package.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-package/Rcpp-package.Rnw	2011-04-12 02:19:06 UTC (rev 2993)
+++ pkg/Rcpp/inst/doc/Rcpp-package/Rcpp-package.Rnw	2011-04-12 02:24:57 UTC (rev 2994)
@@ -90,7 +90,7 @@
 
 \abstract{
   \noindent This document provides a short overview of how to use
-  \pkg{Rcpp}~\citep{CRAN:Rcpp} when writing an \proglang{R} package.  It
+  \pkg{Rcpp}~\citep{CRAN:Rcpp,JSS:Rcpp} when writing an \proglang{R} package.  It
   shows how usage of the function \Sexpr{link("Rcpp.package.skeleton")}
   which creates a complete and self-sufficient example package using
   \pkg{Rcpp}. All components of the directory tree created by
@@ -102,7 +102,7 @@
 
 \section{Introduction}
 
-\pkg{Rcpp}~\citep{CRAN:Rcpp} is an extension package for \proglang{R} which
+\pkg{Rcpp}~\citep{CRAN:Rcpp,JSS:Rcpp} is an extension package for \proglang{R} which
 offers an easy-to-use yet featureful interface between \proglang{C++} and
 \proglang{R}.  However, it is somewhat different from a traditional
 \proglang{R} package because its key component is a \proglang{C++} library. A

Modified: pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw
===================================================================
--- pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw	2011-04-12 02:19:06 UTC (rev 2993)
+++ pkg/Rcpp/inst/doc/Rcpp-sugar/Rcpp-sugar.Rnw	2011-04-12 02:24:57 UTC (rev 2994)
@@ -57,7 +57,7 @@
 \abstract{
   \noindent
   This note describes \sugar~which has been introduced in
-  version 0.8.3 of \pkg{Rcpp} \citep{CRAN:Rcpp}. \sugar~
+  version 0.8.3 of \pkg{Rcpp} \citep{CRAN:Rcpp,JSS:Rcpp}. \sugar~
   brings a higher-level of abstraction to \proglang{C++} code
   written using the \pkg{Rcpp} API.