[Rcpp-commits] r1859 - pkg/Rcpp/man

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

Author: romain
Date: 2010-07-16 12:02:25 +0200 (Fri, 16 Jul 2010)
New Revision: 1859

Modified:
   pkg/Rcpp/man/Rcpp-package.Rd
Log:
forward to introduction vignett

Modified: pkg/Rcpp/man/Rcpp-package.Rd
===================================================================
--- pkg/Rcpp/man/Rcpp-package.Rd	2010-07-16 09:45:12 UTC (rev 1858)
+++ pkg/Rcpp/man/Rcpp-package.Rd	2010-07-16 10:02:25 UTC (rev 1859)
@@ -7,45 +7,12 @@
   greatly facilitate interfacing C or C++ code in \R packages using
   the \code{.Call} interface provided by \R.
 }
-\section{Overview}{
+\section{Introduction}{
+	\pkg{Rcpp} provides C++ classes to facilitate manipulation of a large 
+	number of R data structures : vectors, functions, environments, ... 
 	
-  \pkg{Rcpp} provides matching C++ classes for a large number of
-  basic \R data types. Hence, a package author can keep his data in
-  normal R data structure without having to worry about translation or
-  transfer to C++. At the same time, the data structures can be accessed
-  as easily at the C++ level, and used in the normal manner.
-
-  The mapping of data types works in both directions. It is as
-  straightforward to pass data from R to C++, as it is it return data
-  from C++ to \R.  The following two sections list supported data types.
+	The "Rcpp-introduction" vignette gives an introduction on the package
 }
-\section{Transfer from R to C++}{
-  Standard \R datatypes that are understood are
-  \enumerate{
-    \item named lists containing numeric (i.e. floating point), integer,
-    character, logical (i.e. boolean) or Date and Datetime
-    (i.e. POSIXct) arguments;
-    \item data frames containing numeric, integer, logical, character,
-    Date, Datetime or Factor columns;
-    \item named vectors containing numeric or integer values,
-    \item vectors and matrices of different values
-    \item character strings
-  }
-}
-\section{Transfer from C++ to R}{
-  Standard C++ datatypes can be returned to \R in a named list, the most
-  general data type in \R.  Permissible components of the returns list
-  are the following C++ types:
-  \enumerate{
-    \item double (scalar as well as vectors and vectors of vectors),
-    \item int (scalar as well as vectors and vectors of vectors),
-    \item string,
-    \item STL vector types and vector<vector> types of int and double
-    \item STL vector of strings
-    \item internal Rcpp types RcppDate, RcppDateVector, RcppDatetime,
-  RcppDatetimeVector, RcppStringVector, RcppVector of int or double,
-  RcppMatrix of int or double, RcppFrame}
-}
 \section{Usage for package building}{
 	The "Rcpp-package" vignette documents how to use Rcpp in client packages.
 }
@@ -55,7 +22,10 @@
   Francois have been extending Rcpp since 2009.
 }
 \examples{
-\dontrun{
+\dontrun{                  
+# introduction to Rcpp
+vignette( "Rcpp-introduction" )	
+
 # information on how to build a package that uses Rcpp
 vignette( "Rcpp-package" )	
 }