[Rcpp-commits] r862 - in pkg/Rcpp: inst man src/Rcpp/internal

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

Author: romain
Date: 2010-03-09 08:38:24 +0100 (Tue, 09 Mar 2010)
New Revision: 862

Modified:
   pkg/Rcpp/inst/ChangeLog
   pkg/Rcpp/man/Rcpp.package.skeleton.Rd
   pkg/Rcpp/src/Rcpp/internal/wrap.h
Log:
some more documentation on Rcpp.package.skeleton

Modified: pkg/Rcpp/inst/ChangeLog
===================================================================
--- pkg/Rcpp/inst/ChangeLog	2010-03-08 12:39:55 UTC (rev 861)
+++ pkg/Rcpp/inst/ChangeLog	2010-03-09 07:38:24 UTC (rev 862)
@@ -1,3 +1,7 @@
+2010-03-09  Romain Francois <romain at r-enthusiasts.com>
+
+	* man/Rcpp.package.skeleton.Rd: some more documentation
+
 2010-03-07  Dirk Eddelbuettel  <edd at debian.org>
 
 	* inst/doc/Rcpp-introduction.Rnw: Added vignette based on a recent paper

Modified: pkg/Rcpp/man/Rcpp.package.skeleton.Rd
===================================================================
--- pkg/Rcpp/man/Rcpp.package.skeleton.Rd	2010-03-08 12:39:55 UTC (rev 861)
+++ pkg/Rcpp/man/Rcpp.package.skeleton.Rd	2010-03-09 07:38:24 UTC (rev 862)
@@ -30,12 +30,19 @@
 	The \samp{DESCRIPTION} file gains a Depends line requesting that 
 	the package depends on Rcpp
 	
-	The \samp{NAMESPACE}, if any, gains a \code{useDynLib} directove
+	The \samp{NAMESPACE}, if any, gains a \code{useDynLib} directive
 	
 	The \samp{src} directory is created if it does not exists and 
 	a \samp{Makevars} file is added setting the environment variables
-	\samp{PKG_CXXFLAGS} and \samp{PKG_LIBS}
-
+	\samp{PKG_CXXFLAGS} and \samp{PKG_LIBS} to accomodate the necessary flags
+	to link with the Rcpp library. 
+	
+	Example files \samp{rcpp_hello_world.h} and \samp{rcpp_hello_world.cpp}
+	are also created in the \samp{src}. An R file \samp{rcpp_hello_world.R} is 
+	expanded in the \samp{R} directory, the \code{rcpp_hello_world} function
+	defined in this files makes use of the C++ function \samp{rcpp_hello_world}
+	defined in the C++ file. These files are given as an example and should 
+	eventually by removed from the generated package.
 }
 \value{
 Nothing, used for its side effects
@@ -43,6 +50,13 @@
 \seealso{
 \link[utils]{package.skeleton}
 }
+\references{
+Read the \emph{Writing R Extensions} manual for more details.
+
+Once you have created a \emph{source} package you need to install it:
+see the \emph{R Installation and Administration} manual,
+\code{\link{INSTALL}} and \code{\link{install.packages}}.
+}
 \examples{
 \dontrun{
 f <- function(){}

Modified: pkg/Rcpp/src/Rcpp/internal/wrap.h
===================================================================
--- pkg/Rcpp/src/Rcpp/internal/wrap.h	2010-03-08 12:39:55 UTC (rev 861)
+++ pkg/Rcpp/src/Rcpp/internal/wrap.h	2010-03-09 07:38:24 UTC (rev 862)
@@ -23,6 +23,8 @@
 #ifndef Rcpp_internal_wrap_h
 #define Rcpp_internal_wrap_h
 
+#include <iterator>
+
 // this is a private header, included in RcppCommon.h
 // don't include it directly