[Rcpp-commits] r1882 - in pkg/RcppExamples: inst man

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

Author: romain
Date: 2010-07-29 23:11:09 +0200 (Thu, 29 Jul 2010)
New Revision: 1882

Added:
   pkg/RcppExamples/inst/TODO
Modified:
   pkg/RcppExamples/man/RcppDate.Rd
   pkg/RcppExamples/man/RcppParams.Rd
   pkg/RcppExamples/man/RcppResultSet.Rd
   pkg/RcppExamples/man/RcppVector.Rd
Log:
few more words

Added: pkg/RcppExamples/inst/TODO
===================================================================
--- pkg/RcppExamples/inst/TODO	                        (rev 0)
+++ pkg/RcppExamples/inst/TODO	2010-07-29 21:11:09 UTC (rev 1882)
@@ -0,0 +1,4 @@
+
+o	reorganize Rd files so that RcppExamples emphacizes the new API instead 
+	of the old Rcpp API
+

Modified: pkg/RcppExamples/man/RcppDate.Rd
===================================================================
--- pkg/RcppExamples/man/RcppDate.Rd	2010-07-29 13:51:24 UTC (rev 1881)
+++ pkg/RcppExamples/man/RcppDate.Rd	2010-07-29 21:11:09 UTC (rev 1882)
@@ -26,15 +26,10 @@
   precision in timestamps. This is fully supported by \code{Rcpp} as
   well.
 
-  The new API currently has no explicit Date or Datetime types.
+  The new API currently has the classes \code{Rcpp::Date}, \code{Rcpp::Datetime}, 
+  \code{Rcpp::DateVector} and \code{Rcpp::DatetimeVector} which are preferred
+  for new developments, but currently less documented. 
 }
-%\usage{
-%}
-%\arguments{
-%}
-%\value{
-%  Internal to the C++ code.
-%}
 \details{
   Usage of the \code{RcppDate}, \code{RcppDatetime} (and their vector
   extensions) in \code{C++} is fully defined in the respective header

Modified: pkg/RcppExamples/man/RcppParams.Rd
===================================================================
--- pkg/RcppExamples/man/RcppParams.Rd	2010-07-29 13:51:24 UTC (rev 1881)
+++ pkg/RcppExamples/man/RcppParams.Rd	2010-07-29 21:11:09 UTC (rev 1882)
@@ -12,6 +12,11 @@
   or \code{Date}. These types are mapped into, respectively, the
   corresponding C++ types \code{double},  \code{int}, \code{string},
   \code{bool} and \code{Date} (a custom class defined by \code{Rcpp}.
+  
+  \code{RcppParams} is part of the old Rcpp API, and should be replace by 
+  \code{Rcpp::List} which is more flexible and can be used for both inputs and
+  outputs. \code{RcppParams} is retained for backwards compatibility, but 
+  should be avoided in new projects and replaced in old projects.
 }
 \usage{
   val <- RcppParamsExample(params) 

Modified: pkg/RcppExamples/man/RcppResultSet.Rd
===================================================================
--- pkg/RcppExamples/man/RcppResultSet.Rd	2010-07-29 13:51:24 UTC (rev 1881)
+++ pkg/RcppExamples/man/RcppResultSet.Rd	2010-07-29 21:11:09 UTC (rev 1882)
@@ -26,13 +26,6 @@
 
   The new API has more generic templated functions.
 }
-%\usage{
-%}
-%\arguments{
-%}
-%\value{
-%  Internal to the C++ code.
-%}
 \details{
   Usage of \code{RcppResultSet} from  \code{C++} is fully defined in
   \code{RcppResultSet.h}. An example for returning data to \R at the end of a
@@ -77,9 +70,6 @@
   \code{SEXP} object passed to the function contains a given set of
   named object.
 }
-%\references{
-%  See \code{Rcpp.h} and the package vignette.
-%}
 \seealso{
   \code{RcppExample}.
 }

Modified: pkg/RcppExamples/man/RcppVector.Rd
===================================================================
--- pkg/RcppExamples/man/RcppVector.Rd	2010-07-29 13:51:24 UTC (rev 1881)
+++ pkg/RcppExamples/man/RcppVector.Rd	2010-07-29 21:11:09 UTC (rev 1882)
@@ -31,13 +31,6 @@
   \code{RcppMatrixExample.cpp} provide examples for both the classic and
   new APIs.
 }
-%\usage{
-%}
-%\arguments{
-%}
-%\value{
-%  Internal to the C++ code.
-%}
 \details{
   Usage of \code{RcppVector}, \code{RcppMatrix} and
   \code{RcppStringVector} in \code{C++} is fully defined in
@@ -85,9 +78,6 @@
   }
 
 }
-%\references{
-%  See \code{Rcpp.h} and the package vignette.
-%}
 \seealso{
   \code{RcppExample}.
 }