[Rcpp-devel] Rcpp API Reference

[Smith, Dale (Norcross)]

Doxygen is so useful because it’s automatically generated. Keeping up with additions or changes with hand-crafted API documentation is not easy.

You should at least include a link to the Rcpp Gallery.

http://gallery.rcpp.org/

I’d prefer detailed documentation for the unit tests as they are very useful.

Dale Smith, Ph.D.
Senior Financial Quantitative Analyst
Financial & Risk Management Solutions
Fiserv
Office: 678-375-5315
www.fiserv.com<http://www.fiserv.com/>


From: rcpp-devel-bounces at r-forge.wu-wien.ac.at [mailto:rcpp-devel-bounces at r-forge.wu-wien.ac.at] On Behalf Of Yixuan Qiu
Sent: Wednesday, September 03, 2014 11:03 PM
To: rcpp-devel at lists.r-forge.r-project.org
Subject: [Rcpp-devel] Rcpp API Reference

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!

Best,
Yixuan

--
Yixuan Qiu <yixuan.qiu at cos.name<mailto:yixuan.qiu at cos.name>>
Department of Statistics,
Purdue University
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.r-forge.r-project.org/pipermail/rcpp-devel/attachments/20140904/4a4444cc/attachment.html>