@@ -42,6 +42,8 @@ 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
+ ## Examples
46
+
45
47
Many examples are included, and over 800 unit tests in over 400 unit
46
48
test functions provide additional usage examples.
47
49
@@ -51,8 +53,13 @@ been factored out of Rcpp into the package RcppClassic, and it is still
51
53
available for code relying on the older interface. New development should
52
54
always use this Rcpp package instead.
53
55
56
+ ## Documentation
57
+
58
+ The package ships with nine pdf vignettes.
59
+
54
60
Additional documentation is available via the [ JSS paper] ( http://www.jstatsoft.org/v40/i08/ ) by Eddelbuettel and
55
- Francois (2011, JSS) paper and the [ book] ( http://www.rcpp.org/book ) by Eddelbuettel (2013, Springer);
61
+ Francois (2011, JSS) paper (corresponding to the 'intro' vignette)
62
+ and the [ book] ( http://www.rcpp.org/book ) by Eddelbuettel (2013, Springer);
56
63
see 'citation("Rcpp")' for details.
57
64
58
65
## Installation
@@ -64,14 +71,15 @@ Released and tested versions of Rcpp are available via the
64
71
install.packages(" Rcpp" )
65
72
```
66
73
67
- To install Rcpp snapshots directly from the master branch at GitHub, do
68
-
69
- ``` R
70
- install.packages(" devtools" )
71
- devtools :: install_github(" RcppCore/Rcpp" )
72
- ```
73
-
74
74
To install from source, ensure you have a
75
75
[ complete package development environment] ( http://www.rstudio.com/ide/docs/packages/prerequisites ) .
76
-
77
76
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
+
78
+ ### Authors
79
+
80
+ Dirk Eddelbuettel, Romain Francois, JJ Allaire, Doug Bates, John Chamber and
81
+ Kevin Ushey
82
+
83
+ ### License
84
+
85
+ GPL (>= 2)
0 commit comments