From 79f8cbc5f0f54a100b8a118eccd0c1965a9b3e04 Mon Sep 17 00:00:00 2001 From: Lovemore Gakava Date: Wed, 2 Oct 2024 09:52:50 +0000 Subject: [PATCH] docs: update description to bump up version Added news on making package public and updated documentation for run. --- .Rbuildignore | 3 +++ .gitignore | 3 +++ DESCRIPTION | 2 +- NEWS.md | 3 +++ man/run.Rd | 3 +-- 5 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.Rbuildignore b/.Rbuildignore index 18dc1b4..6c7d78e 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -13,3 +13,6 @@ ^dev/ summary.html plot1.png +^whirl\.Rcheck$ +^whirl.*\.tar\.gz$ +^whirl.*\.tgz$ diff --git a/.gitignore b/.gitignore index 6beed19..37d4767 100644 --- a/.gitignore +++ b/.gitignore @@ -62,3 +62,6 @@ summary.html *_log.html inst/doc +whirl.Rcheck/ +whirl*.tar.gz +whirl*.tgz diff --git a/DESCRIPTION b/DESCRIPTION index af7ffbd..f2f7080 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: whirl Title: Logging package -Version: 0.0.5 +Version: 0.1.0 Authors@R: c( person("Aksel", "Thomsen", , "oath@novonordisk.com", role = c("aut", "cre")), person("Lovemore", "Gakava", , "lvgk@novonordisk.com", role = "aut"), diff --git a/NEWS.md b/NEWS.md index 9cf3422..e3a70a8 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,6 @@ +# whirl 0.1.0 (2024-10-01) +* First public release. + # whirl 0.0.5 (2024-09-27) * Updated documentation * README and vignettes are now ready for users. diff --git a/man/run.Rd b/man/run.Rd index 102695f..949b448 100644 --- a/man/run.Rd +++ b/man/run.Rd @@ -45,7 +45,6 @@ e.g. the verbosity of the logs. See \link{options} on how to configure these. script <- system.file("examples/simple/success.R", package = "whirl") run(script) - # Run several scripts in parallel on up to 2 workers scripts <- system.file("examples/simple", c("success.R", "warning.R", "error.R"), package = "whirl") run(scripts, n_workers = 2) @@ -53,6 +52,6 @@ run(scripts, n_workers = 2) # Run scripts in several steps step_1 <- system.file("examples/simple", c("success.R", "warning.R"), package = "whirl") step_2 <- system.file("examples/simple", c("error.R"), package = "whirl") -run(list(scripts_1, scripts_2), n_workers = 2) +run(list(step_1, step_2), n_workers = 2) \dontshow{\}) # examplesIf} }