Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/davidski/tidyrisk-docker

⚖🐋Rocker-based Docker Containers for Tidyrisk
https://github.com/davidski/tidyrisk-docker

colector docker evaluator r rstats tidyrisk

Last synced: about 1 month ago
JSON representation

⚖🐋Rocker-based Docker Containers for Tidyrisk

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.org/davidski/tidyrisk-docker.svg?branch=master)](https://travis-ci.org/davidski/tidyrisk-docker)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)



Visit [tidyrisk.org](https://tidyrisk.org) for more about Tidyrisk.



## Introduction



An all-in-one setup for running [evaluator](https://evaluator.tidyrisk.org). 

Based upon the [rocker](https://hub.docker.com/r/rocker/rstudio/) RStudio 

image, this allows users to have a known working installation of Evaluator and 

all of its dependencies without having to manage a local installation.



##  How to Use



### Interactive Use



1. Install Docker (free community editions for MacOS, Windows, Linux, and 

   several cloud providers are all available via the 

   [Docker Store](https://store.docker.com/search?type=edition&offering=community)).

2. `docker run -d -p 8787:8787 tidyrisk/evaluator:latest`.

3. Navigate with a local web browser to http://localhost:8787.

4. Login to RStudio with the user `rstudio` and the password `rstudio`.



### Simplified Analysis Flow



1. `docker run --rm -v "$(pwd)/evaluator":/data tidyrisk/evaluator:latest create_templates`.

2. Edit the templates in the `evaluator/inputs` subdirectory on your host system.

3. `docker run --rm -v "$(pwd)/evaluator":/data tidyrisk/evaluator:latest run_analysis`.

4. Consume the reports and analysis in the `evaluator/results` directory on your host system.



### Data Storage



You can share data between your local host and the evaluator instance by 

mounting volumes to the container's `/home/rstudio` directory.



To store data in a pre-existing `data` subdirectory in your host's current 

working directory, use the following command:



> `docker run -d -p 8787:8787 -v $(pwd)/data:/home/rstudio tidyrisk/evaluator:latest`



## See Also



* [tidyrisk](https://tidyrisk.org) - For information on the tidyrisk family.

* [Rocker Wiki](https://github.com/rocker-org/rocker/wiki/Using-the-RStudio-image) - For additional 

options on running and configuring the Dockerized RStudio instance.



### Alternative Images



| Image Name | Description | Size | 

|------------|-------------|------|

| `evaluator` | Evaluator | [![](https://images.microbadger.com/badges/image/tidyrisk/evaluator.svg)](https://microbadger.com/images/tidyrisk/evaluator) |

| `collector` | **Not yet built** A container with the collector package pre-installed. | [![](https://images.microbadger.com/badges/image/tidyrisk/collector.svg)](https://microbadger.com/images/tidyrisk/collector) |

| `tidyrisk` | **Not yet built** A combined collector & evaluator image. | [![](https://images.microbadger.com/badges/image/tidyrisk/tidyrisk.svg)](https://microbadger.com/images/tidyrisk/tidyrisk) |

| `evaluator-noLD` | **Not yet built** Evaluator installed with r-devel without long double support. This is an internal container used for testing tidyrisk prior to CRAN release. | [![](https://images.microbadger.com/badges/image/tidyrisk/evaluator.svg)](https://microbadger.com/images/tidyrisk/evaluator) |



NoLD tests are executed using the Rdevel instance via:



```bash

RD CMD build .

RD CMD check --as-cran evaluator*

```



## Contributing



This project is governed by a [Code of Conduct](./CODE_OF_CONDUCT.md). By 

participating in this project you agree to abide by these terms.



## License



The [MIT License](LICENSE) applies.