Merge pull request #116 from infosiftr/r-updates

Flow R docs to 80 columns
This commit is contained in:
Tianon Gravi 2014-12-02 15:05:25 -08:00
commit 2d52632ddd
4 changed files with 32 additions and 22 deletions

View File

@ -48,11 +48,14 @@ Launch R directly for interactive work:
## Batch mode ## ## Batch mode ##
Link the working directory to run R batch commands. We recommend specifying a non-root user when linking a volume to the container to avoid permission changes, as illustrated here: Link the working directory to run R batch commands. We recommend specifying a
non-root user when linking a volume to the container to avoid permission
changes, as illustrated here:
docker run -ti --rm -v $(pwd):/home/docker -w /home/docker -u docker r-base R CMD check . docker run -ti --rm -v $(pwd):/home/docker -w /home/docker -u docker r-base R CMD check .
Alternatively, just run a bash session on the container first. This allows a user to run batch commands and also edit and run scripts: Alternatively, just run a bash session on the container first. This allows a
user to run batch commands and also edit and run scripts:
docker run -ti --rm r-base /usr/bin/bash docker run -ti --rm r-base /usr/bin/bash
vim.tiny myscript.R vim.tiny myscript.R
@ -61,10 +64,10 @@ Write the script in the container, exit `vim` and run `Rscript`
Rscript myscript.R Rscript myscript.R
## Dockerfiles ## ## Dockerfiles ##
Use `r-base` as a base for your own Dockerfiles. For instance, something along the lines of the following will compile and run your project: Use `r-base` as a base for your own Dockerfiles. For instance, something along
the lines of the following will compile and run your project:
FROM r-base:latest FROM r-base:latest
COPY . /usr/local/src/myscripts COPY . /usr/local/src/myscripts
@ -75,15 +78,17 @@ Build your image with the command:
docker build -t myscript /path/to/Dockerfile docker build -t myscript /path/to/Dockerfile
Running this container with no command will execute the script. Alternatively, a user could run this container in interactive or batch mode as described above, instead of linking volumes. Running this container with no command will execute the script. Alternatively, a
user could run this container in interactive or batch mode as described above,
instead of linking volumes.
Further documentation and example use cases can be found at the
[rocker-org](https://github.com/rocker-org/rocker/wiki) project wiki.
Further documentation and example use cases can be found at the [rocker-org](https://github.com/rocker-org/rocker/wiki) project wiki.
# License # License
View [R-project license information](http://www.r-project.org/Licenses/) for the software contained in this image. View [R-project license information](http://www.r-project.org/Licenses/) for the
software contained in this image.
# User Feedback # User Feedback
@ -92,7 +97,8 @@ View [R-project license information](http://www.r-project.org/Licenses/) for the
If you have any problems with or questions about this image, please contact us 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). through a [GitHub issue](https://github.com/rocker-org/rocker/issues).
You can also reach us by email via email at `rocker-maintainers@eddelbuettel.com`. You can also reach us by email via email at
`rocker-maintainers@eddelbuettel.com`.
## Contributing ## Contributing

View File

@ -38,11 +38,14 @@ Launch R directly for interactive work:
## Batch mode ## ## Batch mode ##
Link the working directory to run R batch commands. We recommend specifying a non-root user when linking a volume to the container to avoid permission changes, as illustrated here: Link the working directory to run R batch commands. We recommend specifying a
non-root user when linking a volume to the container to avoid permission
changes, as illustrated here:
docker run -ti --rm -v $(pwd):/home/docker -w /home/docker -u docker r-base R CMD check . docker run -ti --rm -v $(pwd):/home/docker -w /home/docker -u docker r-base R CMD check .
Alternatively, just run a bash session on the container first. This allows a user to run batch commands and also edit and run scripts: Alternatively, just run a bash session on the container first. This allows a
user to run batch commands and also edit and run scripts:
docker run -ti --rm r-base /usr/bin/bash docker run -ti --rm r-base /usr/bin/bash
vim.tiny myscript.R vim.tiny myscript.R
@ -51,10 +54,10 @@ Write the script in the container, exit `vim` and run `Rscript`
Rscript myscript.R Rscript myscript.R
## Dockerfiles ## ## Dockerfiles ##
Use `r-base` as a base for your own Dockerfiles. For instance, something along the lines of the following will compile and run your project: Use `r-base` as a base for your own Dockerfiles. For instance, something along
the lines of the following will compile and run your project:
FROM r-base:latest FROM r-base:latest
COPY . /usr/local/src/myscripts COPY . /usr/local/src/myscripts
@ -65,9 +68,9 @@ Build your image with the command:
docker build -t myscript /path/to/Dockerfile docker build -t myscript /path/to/Dockerfile
Running this container with no command will execute the script. Alternatively, a user could run this container in interactive or batch mode as described above, instead of linking volumes. Running this container with no command will execute the script. Alternatively, a
user could run this container in interactive or batch mode as described above,
instead of linking volumes.
Further documentation and example use cases can be found at the [rocker-org](https://github.com/rocker-org/rocker/wiki) project wiki.
Further documentation and example use cases can be found at the
[rocker-org](https://github.com/rocker-org/rocker/wiki) project wiki.

View File

@ -1,2 +1,2 @@
View [R-project license information](http://www.r-project.org/Licenses/) for the software contained in this image. View [R-project license information](http://www.r-project.org/Licenses/) for the
software contained in this image.

View File

@ -3,7 +3,8 @@
If you have any problems with or questions about this image, please contact us If you have any problems with or questions about this image, please contact us
%%MAILING_LIST%% through a [GitHub issue](%%GITHUB_REPO%%/issues). %%MAILING_LIST%% through a [GitHub issue](%%GITHUB_REPO%%/issues).
You can also reach us by email via email at `rocker-maintainers@eddelbuettel.com`. You can also reach us by email via email at
`rocker-maintainers@eddelbuettel.com`.
## Contributing ## Contributing