Skip to content

Contributing to the Rcpp Gallery

Jump to bottom
jjallaire edited this page Dec 18, 2012 · 20 revisions

Contributions to the Rcpp Gallery are very welcome. To encourage broad use in both open-source and commercial projects, all of the code in the Rcpp Gallery is published under the MIT License.

Rcpp Gallery articles are very straightforward to create and consist of a single source file (either C++ or R Markdown). There are two ways to contribute an article:

  1. Fork the Rcpp Gallery website and submit a pull request with your new or updated articles; or

  2. Post your article on the web (e.g. using a Gist) and then submit an issue requesting that we include the article.

In either case, you can choose one of two authoring formats:

  1. Doxygen — A C++ source file annotated with Doxygen comments that are converted into freestanding text when published to the web (for more details see Doxygen-Articles).

  2. R Markdown — A source file that intermixes C++ and R code with markdown formatted text (for more details see R-Markdown-Articles).

If you are submitting a pull request or want to preview what your article will look like once it's published, you'll likely want to clone the Rcpp Gallery repository and setup a local development configuration. Details on doing this are covered in the Development article.

Clone this wiki locally