Skip to content

Commit 5c56d8a

Browse files
committed
mention Rcpp Gallery in README
1 parent de5bc00 commit 5c56d8a

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,33 @@ package development. Attributes are built on top of Rcpp modules and
4242
their implementation is based on previous work in the inline package.
4343
See the [Rcpp-atttributes]((http://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-attributes.pdf) vignettes for more details.
4444

45+
## Documentation
46+
47+
The package ships with nine pdf vignettes.
48+
49+
Additional documentation is available via the
50+
[JSS paper](http://www.jstatsoft.org/v40/i08/) by Eddelbuettel and
51+
Francois (2011, JSS) paper (corresponding to the 'intro' vignette)
52+
and the [book](http://www.rcpp.org/book) by Eddelbuettel (2013, Springer);
53+
see 'citation("Rcpp")' for details.
54+
4555
## Examples
4656

47-
Many examples are included, and over 800 unit tests in over 400 unit
48-
test functions provide additional usage examples.
57+
The [Rcpp Gallery](http://gallery.rcpp.org) showcases over 70 fully documented
58+
and working examples.
59+
60+
A number of examples are included as are over 800 unit tests in over 400 unit
61+
test functions provide additional usage examples.
62+
63+
The [CRAN](http://cran.r-project.org) network contains
64+
(as over early 2014) over 160 packages which also provide usage examples.
4965

5066
An earlier version of Rcpp, containing what we now call the 'classic Rcpp
5167
API' was written during 2005 and 2006 by Dominick Samperi. This code has
5268
been factored out of Rcpp into the package RcppClassic, and it is still
5369
available for code relying on the older interface. New development should
5470
always use this Rcpp package instead.
5571

56-
## Documentation
57-
58-
The package ships with nine pdf vignettes.
59-
60-
Additional documentation is available via the [JSS paper](http://www.jstatsoft.org/v40/i08/) by Eddelbuettel and
61-
Francois (2011, JSS) paper (corresponding to the 'intro' vignette)
62-
and the [book](http://www.rcpp.org/book) by Eddelbuettel (2013, Springer);
63-
see 'citation("Rcpp")' for details.
64-
6572
## Installation
6673

6774
Released and tested versions of Rcpp are available via the
@@ -72,7 +79,7 @@ install.packages("Rcpp")
7279
```
7380

7481
To install from source, ensure you have a
75-
[complete package development environment](http://www.rstudio.com/ide/docs/packages/prerequisites).
82+
[complete package development environment](http://www.rstudio.com/ide/docs/packages/prerequisites).
7683
Also see questions 1.2 and 1.3 in the [Rcpp-FAQ](http://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-FAQ.pdf).
7784

7885
### Authors

0 commit comments

Comments
 (0)