Author: romain
Date: 2010-05-26 17:51:41 +0200 (Wed, 26 May 2010)
New Revision: 1327
Added:
pkg/Rcpp/man/CppClass-class.Rd
pkg/Rcpp/man/CppObject-class.Rd
pkg/Rcpp/man/Module-class.Rd
pkg/Rcpp/man/Module.Rd
Modified:
pkg/Rcpp/DESCRIPTION
pkg/Rcpp/R/Module.R
Log:
just enough documentation to please R CMD check
Modified: pkg/Rcpp/DESCRIPTION
===================================================================
--- pkg/Rcpp/DESCRIPTION 2010-05-26 15:30:30 UTC (rev 1326)
+++ pkg/Rcpp/DESCRIPTION 2010-05-26 15:51:41 UTC (rev 1327)
@@ -46,7 +46,7 @@
.
Several examples are included, and over 530 unit tests in over 240 unit test
functions provide addtional usage examples.
-Depends: R (>= 2.10.0), inline (>= 0.3.4)
+Depends: R (>= 2.10.0), methods, inline (>= 0.3.4)
Suggests: RUnit
SystemRequirements: GNU make
URL: http://dirk.eddelbuettel.com/code/rcpp.html, http://romainfrancois.blog.free.fr/index.php?category/R-package/Rcpp
Modified: pkg/Rcpp/R/Module.R
===================================================================
--- pkg/Rcpp/R/Module.R 2010-05-26 15:30:30 UTC (rev 1326)
+++ pkg/Rcpp/R/Module.R 2010-05-26 15:51:41 UTC (rev 1327)
@@ -56,8 +56,6 @@
writeLines( txt )
} )
-#TODO: maybe attach( Module ), with( Module )
-
setMethod( "new", "C++Class", function(Class, ...){
.External( "class__newInstance", Class at module, Class at pointer, ..., PACKAGE = "Rcpp" )
} )
Added: pkg/Rcpp/man/CppClass-class.Rd
===================================================================
--- pkg/Rcpp/man/CppClass-class.Rd (rev 0)
+++ pkg/Rcpp/man/CppClass-class.Rd 2010-05-26 15:51:41 UTC (rev 1327)
@@ -0,0 +1,30 @@
+\name{C++Class-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{C++Class-class}
+\alias{new,C++Class-method}
+
+\title{Reflection information for an internal c++ class}
+\description{
+Information about an internal c++ class.
+}
+\section{Objects from the Class}{
+ Objects are usually extracted from a \linkS4class{Module}
+ using the dollar extractor.
+}
+\section{Slots}{
+ \describe{
+ \item{\code{pointer}:}{external pointer to the internal infomation}
+ \item{\code{module}:}{external pointer to the module}
+ }
+}
+\section{Methods}{
+ \describe{
+ \item{new}{\code{signature(Class = "C++Class")}: creates a new object
+ of this class using its default constructor. This creates
+ instances of the class \linkS4class{"C++Object"}
+ }
+ }
+}
+\keyword{classes}
+
Added: pkg/Rcpp/man/CppObject-class.Rd
===================================================================
--- pkg/Rcpp/man/CppObject-class.Rd (rev 0)
+++ pkg/Rcpp/man/CppObject-class.Rd 2010-05-26 15:51:41 UTC (rev 1327)
@@ -0,0 +1,27 @@
+\name{C++Object-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{C++Object-class}
+\alias{$,C++Object-method}
+
+\title{c++ internal objects}
+\description{
+C++ internal objects instanciated from a class exposed in an Rcpp module
+}
+\section{Objects from the Class}{
+ Objects can be created by the \code{new} method of the
+ \linkS4class{"C++Class"} class.
+}
+\section{Slots}{
+ \describe{
+ \item{\code{module}:}{external pointer to the module}
+ \item{\code{cppclass}:}{external pointer to the c++ class}
+ \item{\code{pointer}:}{external pointer to the c++ object}
+ }
+}
+\section{Methods}{
+ \describe{
+ \item{$}{\code{signature(x = "C++Object")}: invokes a method on the object }
+ }
+}
+\keyword{classes}
Added: pkg/Rcpp/man/Module-class.Rd
===================================================================
--- pkg/Rcpp/man/Module-class.Rd (rev 0)
+++ pkg/Rcpp/man/Module-class.Rd 2010-05-26 15:51:41 UTC (rev 1327)
@@ -0,0 +1,27 @@
+\name{Module-class}
+\Rdversion{1.1}
+\docType{class}
+\alias{Module-class}
+\alias{$,Module-method}
+
+\title{Rcpp modules}
+\description{
+Collection of internal c++ functions and classes exposed to R
+}
+\section{Objects from the Class}{
+ modules are created by the \code{link{Module}} function
+}
+\section{Slots}{
+ \describe{
+ \item{\code{pointer}:}{ external pointer of class \code{Rcpp::Module} }
+ }
+}
+\section{Methods}{
+ \describe{
+ \item{$}{\code{signature(x = "Module")}: extract a function or a class from the module }
+ }
+}
+\seealso{
+ \code{\link{Module}}
+}
+\keyword{classes}
Added: pkg/Rcpp/man/Module.Rd
===================================================================
--- pkg/Rcpp/man/Module.Rd (rev 0)
+++ pkg/Rcpp/man/Module.Rd 2010-05-26 15:51:41 UTC (rev 1327)
@@ -0,0 +1,22 @@
+\name{Module}
+\alias{Module}
+\title{
+Retrieves an Rcpp module
+}
+\description{
+Retrieves an Rcpp module from a dynamic library, usually associated with a
+package.
+}
+\usage{
+Module(module, PACKAGE)
+}
+\arguments{
+\item{module}{Name of the module, as declared in the \code{RCPP_MODULE} macro internally}
+\item{PACKAGE}{Passed to \code{\link{getNativeSymbolInfo}}}
+}
+\value{
+ An object of class \linkS4class{Module} collecting functions
+ and classes declared in the module.
+}
+\keyword{programming}
+