Skip to content

Commit af076ca

Browse files
committed
refactor readme files: in r tests
1 parent 3ea45d1 commit af076ca

File tree

13 files changed

+43
-23
lines changed

13 files changed

+43
-23
lines changed

tests/r/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Overview of tests for the R buildpack
2+
3+
## Tested configuration files
4+
5+
- [`runtime.txt`](https://repo2docker.readthedocs.io/en/latest/config_files.html#runtime-txt-specifying-runtimes).
6+
- [`DESCRIPTION`](https://repo2docker.readthedocs.io/en/latest/config_files.html#description-install-an-r-package).
7+
- [`install.R`](https://repo2docker.readthedocs.io/en/latest/config_files.html#install-r-install-an-r-rstudio-environment).
8+
- [`requirements.txt`](https://repo2docker.readthedocs.io/en/latest/config_files.html#requirements-txt-install-a-python-environment)
9+
- [`apt.txt`](https://repo2docker.readthedocs.io/en/latest/config_files.html#apt-txt-install-packages-with-apt-get)
10+
11+
## Test folders
12+
13+
### r-rspm-apt-file
14+
15+
- Test setup of the default R environment by omitting a version specification in
16+
`runtime.txt`, where the date provided in `runtime.txt` is recent enough for a
17+
RSPM snapshot of CRAN to be used.
18+
19+
- Test use of a `apt.txt` file.
20+
21+
### r-rspm-description-file
22+
23+
- Test use of a `DESCRIPTION` file instead of an `install.R` file, where a
24+
`runtime.txt` is omitted and a recent enough snapshot date is assumed a RSPM
25+
snapshot of CRAN to be used.
26+
27+
### r3.6-mran
28+
29+
- Test setup of a R 3.6 environment by specifying `r-3.6-...` in `runtime.txt`,
30+
where the date provided in `runtime.txt` is old enough for a MRAN snapshot of
31+
CRAN to be used.
32+
33+
### r4.0-mran
34+
35+
- Test setup of a R 4.0 environment by specifying `r-4.0-...` in `runtime.txt`,
36+
where the date provided in `runtime.txt` is old enough for a MRAN snapshot of
37+
CRAN to be used.
38+
39+
### r4.0-rspm
40+
41+
- Test setup of a R 4.0 environment by specifying `r-4.0-...` in `runtime.txt`,
42+
where the date provided in `runtime.txt` is recent enough for a RSPM snapshot
43+
of CRAN to be used.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

tests/r/r-rspm-apt/README.rst

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)