[Rcpp-devel] Rcpp API Reference

[Gabor Grothendieck]

On Wed, Sep 3, 2014 at 11:03 PM, Yixuan Qiu <yixuan.qiu at cos.name> wrote:
> Dear all,
> I believe that everyone in this list has seen the benefit of using Rcpp to
> incorporate C++ code and develop R packages, but it's also the fact that
> currently there is rarely a complete reference which documents every detail
> of the classes and functions inside Rcpp.
> To make this situation a little bit better, recently I've created a project
> that aims to accomplish this long run target. A quick view of what it looks
> like is available at my site: http://statr.me/rcpp-note/
> Basically it's like the Doxygen documentation, but the content here was
> manually added rather than extracted from the Rcpp source code. For now I've
> finished some of the most commonly used classes in Rcpp, and do hope that
> more people are joining in, either by reviewing and correcting the existing
> documentation, or contributing your own knowledge.
> I wish this project would be helpful for those who want to use Rcpp in their
> code and packages, and be more powerful and complete with the help of you
> experts in this list. If you are also interested in, don't hesistate to go
> to the project repository (https://github.com/yixuan/Rcpp-note), reporting
> mistakes, contributing document or giving suggestions.
> Happy Rcpping!
>

This is great. Thanks.

Particularly like the small code examples and hope that additional
such examples can be added in the future.