Skip to content

Commit b4344c6

Browse files
committed
mention the Rcpp drat core in installation section
1 parent 11276eb commit b4344c6

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

ChangeLog

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
* DESCRIPTION (Version, Date): Roll minor version
44
* inst/include/Rcpp/config.h: Idem
55

6+
* README.md: Mention the Rcpp drap repo and its release candidates in
7+
installation section
8+
69
2021-01-28 Iñaki Ucar <iucar@fedoraproject.org>
710

811
* inst/include/Rcpp/iostream/Rstreambuf.h: Support for global Rcout/Rcerr by

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,18 +105,49 @@ using Rcpp. All these packages provide usage examples for Rcpp.
105105

106106
### Installation
107107

108-
Released and tested versions of Rcpp are available via the
109-
[CRAN](https://cran.r-project.org) network, and can be installed from within R via
108+
#### CRAN
109+
110+
Rcpp released on CRAN are carefully tested and curated. CRAN ensures they interoperate
111+
with all other CRAN package on all test environment. The released and tested versions
112+
are available via all mirrors of [CRAN](https://cran.r-project.org) network, and can be
113+
installed from within R via
110114

111115
```R
112116
install.packages("Rcpp")
113117
```
114118

119+
#### Release Candidates
120+
121+
For the last several releases, we also made interim _candidate_ releases available
122+
on the [Rcpp Drat Repo](https://RcppCore.github.io/drat). Versions from a
123+
[drat](https://github.com/eddelbuettel/drat) repo can be installed either by
124+
just temporarily setting the [drat](https://github.com/eddelbuettel/drat) repo as in
125+
126+
```R
127+
install.packages("Rcpp", repos="https://RcppCore.github.io/drat")
128+
```
129+
130+
or by setting a [drat](https://github.com/eddelbuettel/drat) repo more permanently
131+
(as described in the documentation of the [drat](https://github.com/eddelbuettel/drat)
132+
package).
133+
134+
Testing the release candidates prior to actual release help. Please run this if you can.
135+
136+
#### Source
137+
115138
To install from source, ensure you have a complete package development
116139
environment for R as discussed in the relevant documentation; also see
117140
questions 1.2 and 1.3 in the
118141
[Rcpp-FAQ](https://cran.r-project.org/package=Rcpp/vignettes/Rcpp-FAQ.pdf).
119142

143+
#### Less Common Versions and Platforms
144+
145+
If you want to run Rcpp on another (not-tested on CRAN) platform, or on releases
146+
older than the previous release, we suggest you do your due diligence and test
147+
accordingly. Rcpp is provided by an all-volunteer team with finite resources.
148+
We work hard to test Rcpp with several thousand CRAN packages using it---but
149+
we cannot test on outdated versions of R or your OS.
150+
120151
### Support
121152

122153
The best place for questions is the

0 commit comments

Comments
 (0)