From 3b82d6b92ce5f106856d01dbc9e87d5eb74330a8 Mon Sep 17 00:00:00 2001 From: Joe Ferguson Date: Tue, 2 Dec 2014 14:38:01 -0800 Subject: [PATCH] Flow R docs to 80 columns --- r-base/README.md | 26 ++++++++++++++++---------- r-base/content.md | 21 ++++++++++++--------- r-base/license.md | 4 ++-- r-base/user-feedback.md | 3 ++- 4 files changed, 32 insertions(+), 22 deletions(-) diff --git a/r-base/README.md b/r-base/README.md index 84e8a0482..fc712ec8a 100644 --- a/r-base/README.md +++ b/r-base/README.md @@ -48,11 +48,14 @@ Launch R directly for interactive work: ## 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 . -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 vim.tiny myscript.R @@ -61,10 +64,10 @@ Write the script in the container, exit `vim` and run `Rscript` Rscript myscript.R - ## 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 COPY . /usr/local/src/myscripts @@ -75,15 +78,17 @@ Build your image with the command: 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 -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 @@ -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 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 diff --git a/r-base/content.md b/r-base/content.md index 78b660bc8..e433d8080 100644 --- a/r-base/content.md +++ b/r-base/content.md @@ -38,11 +38,14 @@ Launch R directly for interactive work: ## 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 . -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 vim.tiny myscript.R @@ -51,10 +54,10 @@ Write the script in the container, exit `vim` and run `Rscript` Rscript myscript.R - ## 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 COPY . /usr/local/src/myscripts @@ -65,9 +68,9 @@ Build your image with the command: 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. - - - -Further documentation and example use cases can be found at the [rocker-org](https://github.com/rocker-org/rocker/wiki) project wiki. +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. diff --git a/r-base/license.md b/r-base/license.md index 3eef07d01..36c2c5e8a 100644 --- a/r-base/license.md +++ b/r-base/license.md @@ -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. diff --git a/r-base/user-feedback.md b/r-base/user-feedback.md index 5783091d5..227531523 100644 --- a/r-base/user-feedback.md +++ b/r-base/user-feedback.md @@ -3,7 +3,8 @@ If you have any problems with or questions about this image, please contact us %%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