@@ -42,26 +42,33 @@ package development. Attributes are built on top of Rcpp modules and
42
42
their implementation is based on previous work in the inline package.
43
43
See the [ Rcpp-atttributes] ((http://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-attributes.pdf ) vignettes for more details.
44
44
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
+
45
55
## Examples
46
56
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.
49
65
50
66
An earlier version of Rcpp, containing what we now call the 'classic Rcpp
51
67
API' was written during 2005 and 2006 by Dominick Samperi. This code has
52
68
been factored out of Rcpp into the package RcppClassic, and it is still
53
69
available for code relying on the older interface. New development should
54
70
always use this Rcpp package instead.
55
71
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
-
65
72
## Installation
66
73
67
74
Released and tested versions of Rcpp are available via the
@@ -72,7 +79,7 @@ install.packages("Rcpp")
72
79
```
73
80
74
81
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 ) .
76
83
Also see questions 1.2 and 1.3 in the [ Rcpp-FAQ] ( http://cran.r-project.org/web/packages/Rcpp/vignettes/Rcpp-FAQ.pdf ) .
77
84
78
85
### Authors
0 commit comments