Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 3.31 KB

README.md

File metadata and controls

71 lines (48 loc) · 3.31 KB
Raw

Build Status license

Visit tidyrisk.org for more about Tidyrisk.

Introduction

An all-in-one setup for running evaluator. Based upon the rocker 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).
  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 - For information on the tidyrisk family.
  • Rocker Wiki - For additional options on running and configuring the Dockerized RStudio instance.

Alternative Images

Image Name Description Size
evaluator Evaluator
collector Not yet built A container with the collector package pre-installed.
tidyrisk Not yet built A combined collector & evaluator image.
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.

NoLD tests are executed using the Rdevel instance via:

RD CMD build .
RD CMD check --as-cran evaluator*

Contributing

This project is governed by a Code of Conduct. By participating in this project you agree to abide by these terms.

License

The MIT License applies.