From fb5ef4e4f559751c6453f3d3ee60c8f090e770b3 Mon Sep 17 00:00:00 2001 From: oath_nngithub Date: Thu, 31 Oct 2024 17:35:45 +0100 Subject: [PATCH] fix: make broken links to always point to the published site for main --- README.Rmd | 6 +++--- README.md | 28 +++++++++++++++++----------- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/README.Rmd b/README.Rmd index d166d71..9d7d408 100644 --- a/README.Rmd +++ b/README.Rmd @@ -19,7 +19,7 @@ options(whirl.verbosity_level = "minimal") -[![R-CMD-check](https://github.com/NN-OpenSource/whirl/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/NN-OpenSource/whirl/actions/workflows/R-CMD-check.yaml) +[![Checks](https://github.com/NovoNordisk-OpenSource/whirl/actions/workflows/check_and_co.yaml/badge.svg)](https://github.com/NovoNordisk-OpenSource/whirl/actions/workflows/check_and_co.yaml) @@ -61,8 +61,8 @@ meaning that they will be executed in parallel. When using `run()` the following files are created: -1. Creates a log in the same directory as the script with the names `{script_name}_log.html`. See [example_log.html](articles/example_log.html) for an example of a simple log. -1. Creates a summary log with the overall status of each script. Default path is `summary.html`. See [summary.html](articles/summary.html) for an example of a summary of the same log as above. +1. Creates a log in the same directory as the script with the names `{script_name}_log.html`. See [example_log.html](https://novonordisk-opensource.github.io/whirl/articles/example_log.html) for an example of a simple log. +1. Creates a summary log with the overall status of each script. Default path is `summary.html`. See [summary.html](https://novonordisk-opensource.github.io/whirl/articles/summary.html) for an example of a summary of the same log as above. Apart from this the function also returns a `tibble` with the status of the script execution similar to the content of the summary above: diff --git a/README.md b/README.md index a27245a..a2cc85a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ -[![R-CMD-check](https://github.com/NN-OpenSource/whirl/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/NN-OpenSource/whirl/actions/workflows/R-CMD-check.yaml) +[![Checks](https://github.com/NovoNordisk-OpenSource/whirl/actions/workflows/check_and_co.yaml/badge.svg)](https://github.com/NovoNordisk-OpenSource/whirl/actions/workflows/check_and_co.yaml) @@ -38,7 +38,9 @@ The simplest way is to provide the path to a single script: library(whirl) script <- system.file("examples/simple/success.R", package = "whirl") run(script) +#> ══ Executing scripts and generating logs ═══════════════════════════════════════ #> ✔ success.R: Completed succesfully +#> ══ End of process ══════════════════════════════════════════════════════════════ ``` It is also possible to run several scripts simultaneously: @@ -46,8 +48,10 @@ It is also possible to run several scripts simultaneously: ``` r scripts <- system.file("examples/simple", c("success.R", "warning.R"), package = "whirl") result <- run(scripts, n_workers = 2) +#> ══ Executing scripts and generating logs ═══════════════════════════════════════ #> ✔ success.R: Completed succesfully #> ⚠ warning.R: Completed with warnings +#> ══ End of process ══════════════════════════════════════════════════════════════ ``` Here we are specifying that `run()` can use up to two simultaneous @@ -58,12 +62,12 @@ When using `run()` the following files are created: 1. Creates a log in the same directory as the script with the names `{script_name}_log.html`. See - [example_log.html](articles/example_log.html) for an example of a - simple log. + [example_log.html](https://novonordisk-opensource.github.io/whirl/articles/example_log.html) + for an example of a simple log. 2. Creates a summary log with the overall status of each script. Default path is `summary.html`. See - [summary.html](articles/summary.html) for an example of a summary of - the same log as above. + [summary.html](https://novonordisk-opensource.github.io/whirl/articles/summary.html) + for an example of a summary of the same log as above. Apart from this the function also returns a `tibble` with the status of the script execution similar to the content of the summary above: @@ -73,8 +77,8 @@ print(result) #> # A tibble: 2 × 5 #> id tag script status result #> -#> 1 1 /tmp/RtmpcWMKsm/temp_libpath464a11c9b587c/whi… succe… -#> 2 2 /tmp/RtmpcWMKsm/temp_libpath464a11c9b587c/whi… warni… +#> 1 1 /scer/homedirs/oath/R/x86_64-pc-linux-gnu-lib… succe… +#> 2 2 /scer/homedirs/oath/R/x86_64-pc-linux-gnu-lib… warni… ``` ## Config files @@ -105,9 +109,11 @@ scripts in the second steps. ``` r result <- run(config, n_workers = 2) +#> ══ Executing scripts and generating logs ═══════════════════════════════════════ #> ✔ success.R: Completed succesfully -#> ✖ error.R: Completed with errors #> ⚠ warning.R: Completed with warnings +#> ✖ error.R: Completed with errors +#> ══ End of process ══════════════════════════════════════════════════════════════ ``` ``` r @@ -115,9 +121,9 @@ print(result) #> # A tibble: 3 × 5 #> id tag script status result #> -#> 1 1 /tmp/RtmpcWMKsm/temp_libpath464a11c9b587c/whi… succe… -#> 2 2 /tmp/RtmpcWMKsm/temp_libpath464a11c9b587c/whi… warni… -#> 3 3 /tmp/RtmpcWMKsm/temp_libpath464a11c9b587c/whi… error +#> 1 1 /scer/homedirs/oath/R/x86_64-pc-linux-gnu-lib… succe… +#> 2 2 /scer/homedirs/oath/R/x86_64-pc-linux-gnu-lib… warni… +#> 3 3 /scer/homedirs/oath/R/x86_64-pc-linux-gnu-lib… error ``` ## Customize run()