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
This commit is contained in:
Carl Boettiger 2014-11-11 21:20:06 -08:00
parent 8e97facd3f
commit 878d695448
5 changed files with 88 additions and 0 deletions

1
r-base/README-short.txt Normal file
View File

@ -0,0 +1 @@
R is a free software environment for statistical computing and graphics.

54
r-base/README.md Normal file
View File

@ -0,0 +1,54 @@
# Supported tags and respective `Dockerfile` links
- [`3.1.1` (*3.1/Dockerfile*)](https://github.com/docker-library/gcc/blob/ba6f069df8e6c838d0465b09215e96f8d5d65269/4.6/Dockerfile)
For more information about this image and its history, please see the [relevant
manifest file
(`library/r-base`)](https://github.com/docker-library/official-images/blob/master/library/r-base)
in the [`docker-library/official-images` GitHub
repo](https://github.com/docker-library/official-images).
# What is R?
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.
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.
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.
> [wikipedia.org/wiki/R_(programming_language)](http://en.wikipedia.org/wiki/R_(programming_language))
![logo](https://raw.githubusercontent.com/docker-library/docs/master/r-base/logo.png)
# How to use this image
<!-- -->
# License
View [license information](https://github.com/rocker-org/rocker/blob/master/LICENSE)
for the software contained in this image.
# User Feedback
## Issues
If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/rocker-org/rocker/issues).
You can also reach many of the official image maintainers on Twitter: [@cboettig](http://twitter.com/cboettig) and [@eddelbuettel](http://twitter.com/eddelbuettel).
## Contributing
You are invited to contribute new features, fixes, or updates, large or small;
we are always thrilled to receive pull requests, and do our best to process them
as fast as we can.
Before you start to code, we recommend discussing your plans
through a [GitHub issue](https://github.com/rocker-org/rocker/issues), especially for more ambitious
contributions. This gives other contributors a chance to point you in the right
direction, give you feedback on your design, and help you find out if someone
else is working on the same thing.

31
r-base/content.md Normal file
View File

@ -0,0 +1,31 @@
# What is R?
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.
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.
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.
> [wikipedia.org/wiki/R_(programming_language)](http://en.wikipedia.org/wiki/R_(programming_language))
%%LOGO%%
# How to use this image
## Start an R instance
The most straightforward way to use this image is to use a gcc container as both
the build and runtime environment. In your `Dockerfile`, writing something along
the lines of the following will compile and run your project:
FROM r-base:latest
COPY . /usr/src/myscripts
WORKDIR /usr/src/myscripts
CMD ["Rscript -e myscript.R"]
Then, build and run the Docker image:
docker build -t my-r-app .
docker run -it --rm --name my-running-app my-r-app

2
r-base/license.md Normal file
View File

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

BIN
r-base/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB