From 2d1f8551b083e342cb156b47566974e71937bd2f Mon Sep 17 00:00:00 2001 From: Graham Whaley Date: Fri, 23 Aug 2019 11:42:12 +0100 Subject: [PATCH] metrics: report: update README with new debug mode info Debug mode of the report generator now volume mounts the scripts into the container (rather than just COPYing them in), to allow interactive edit/run debug cycles. Document it. Signed-off-by: Graham Whaley --- metrics/report/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/metrics/report/README.md b/metrics/report/README.md index 0986db2..d320cad 100644 --- a/metrics/report/README.md +++ b/metrics/report/README.md @@ -60,14 +60,18 @@ directory. To aid in script development and debugging, the `makereport.sh` script offers a debug facility via the `-d` command line option. Using this option will place you into a `bash` -shell within the running `Dockerfile` image used to generate the report. From there you -can examine the Docker image environment, and execute the generation scripts. E.g., to -test the `scaling.R` script, you can execute: +shell within the running `Dockerfile` image used to generate the report, whilst also +mapping your host side `R` scripts from the `report_dockerfile` subdirectory into the +container, thus facilitating a 'live' edit/reload/run development cycle. +From there you can examine the Docker image environment, and execute the generation scripts. +E.g., to test the `tidy_scaling.R` script, you can execute: ```bash $ makereport.sh -d # R > source('/inputdir/Env.R') -> source('/scripts/scaling.R') +> source('/scripts/tidy_scaling.R') +## Edit script on host, and re-load/run... +> source('/scripts/tidy_scaling.R') ```