Skip to content

Commit 878d695

Browse files
committed
boilerplate for r-base image documentation
Still needs a proper "how to use this image" section; this just fills in the license, logo, wikipedia summary etc
1 parent 8e97fac commit 878d695

File tree

5 files changed

+88
-0
lines changed

5 files changed

+88
-0
lines changed

Diff for: r-base/README-short.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
R is a free software environment for statistical computing and graphics.

Diff for: r-base/README.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Supported tags and respective `Dockerfile` links
2+
3+
- [`3.1.1` (*3.1/Dockerfile*)](https://github.com/docker-library/gcc/blob/ba6f069df8e6c838d0465b09215e96f8d5d65269/4.6/Dockerfile)
4+
5+
For more information about this image and its history, please see the [relevant
6+
manifest file
7+
(`library/r-base`)](https://github.com/docker-library/official-images/blob/master/library/r-base)
8+
in the [`docker-library/official-images` GitHub
9+
repo](https://github.com/docker-library/official-images).
10+
11+
# What is R?
12+
13+
R is a free software programming language and software environment for statistical computing and graphics. The R language is widely used among statisticians and data miners for developing statistical software and data analysis. Polls and surveys of data miners are showing R's popularity has increased substantially in recent years.
14+
15+
R is an implementation of the S programming language combined with lexical scoping semantics inspired by Scheme. S was created by John Chambers while at Bell Labs. R was created by Ross Ihaka and Robert Gentleman at the University of Auckland, New Zealand, and is currently developed by the R Development Core Team, of which Chambers is a member. R is named partly after the first names of the first two R authors and partly as a play on the name of S.
16+
17+
R is a GNU project. The source code for the R software environment is written primarily in C, Fortran, and R. R is freely available under the GNU General Public License, and pre-compiled binary versions are provided for various operating systems. R uses a command line interface; however, several graphical user interfaces are available for use with R.
18+
19+
> [wikipedia.org/wiki/R_(programming_language)](http://en.wikipedia.org/wiki/R_(programming_language))
20+
21+
![logo](https://raw.githubusercontent.com/docker-library/docs/master/r-base/logo.png)
22+
23+
# How to use this image
24+
25+
<!-- -->
26+
27+
28+
29+
# License
30+
31+
View [license information](https://github.com/rocker-org/rocker/blob/master/LICENSE)
32+
for the software contained in this image.
33+
34+
# User Feedback
35+
36+
## Issues
37+
38+
If you have any problems with or questions about this image, please contact us
39+
through a [GitHub issue](https://github.com/rocker-org/rocker/issues).
40+
41+
You can also reach many of the official image maintainers on Twitter: [@cboettig](http://twitter.com/cboettig) and [@eddelbuettel](http://twitter.com/eddelbuettel).
42+
43+
44+
## Contributing
45+
46+
You are invited to contribute new features, fixes, or updates, large or small;
47+
we are always thrilled to receive pull requests, and do our best to process them
48+
as fast as we can.
49+
50+
Before you start to code, we recommend discussing your plans
51+
through a [GitHub issue](https://github.com/rocker-org/rocker/issues), especially for more ambitious
52+
contributions. This gives other contributors a chance to point you in the right
53+
direction, give you feedback on your design, and help you find out if someone
54+
else is working on the same thing.

Diff for: r-base/content.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# What is R?
2+
3+
R is a free software programming language and software environment for statistical computing and graphics. The R language is widely used among statisticians and data miners for developing statistical software and data analysis. Polls and surveys of data miners are showing R's popularity has increased substantially in recent years.
4+
5+
R is an implementation of the S programming language combined with lexical scoping semantics inspired by Scheme. S was created by John Chambers while at Bell Labs. R was created by Ross Ihaka and Robert Gentleman at the University of Auckland, New Zealand, and is currently developed by the R Development Core Team, of which Chambers is a member. R is named partly after the first names of the first two R authors and partly as a play on the name of S.
6+
7+
R is a GNU project. The source code for the R software environment is written primarily in C, Fortran, and R. R is freely available under the GNU General Public License, and pre-compiled binary versions are provided for various operating systems. R uses a command line interface; however, several graphical user interfaces are available for use with R.
8+
9+
> [wikipedia.org/wiki/R_(programming_language)](http://en.wikipedia.org/wiki/R_(programming_language))
10+
11+
%%LOGO%%
12+
13+
# How to use this image
14+
15+
## Start an R instance
16+
17+
The most straightforward way to use this image is to use a gcc container as both
18+
the build and runtime environment. In your `Dockerfile`, writing something along
19+
the lines of the following will compile and run your project:
20+
21+
FROM r-base:latest
22+
COPY . /usr/src/myscripts
23+
WORKDIR /usr/src/myscripts
24+
CMD ["Rscript -e myscript.R"]
25+
26+
Then, build and run the Docker image:
27+
28+
docker build -t my-r-app .
29+
docker run -it --rm --name my-running-app my-r-app
30+
31+

Diff for: r-base/license.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
View [license information](https://github.com/rocker-org/rocker/blob/master/LICENSE)
2+
for the software contained in this image.

Diff for: r-base/logo.png

13.3 KB
Loading

0 commit comments

Comments
 (0)