diff --git a/.Rbuildignore b/.Rbuildignore index 6c7d78e..f32db70 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -16,3 +16,4 @@ plot1.png ^whirl\.Rcheck$ ^whirl.*\.tar\.gz$ ^whirl.*\.tgz$ +^vignettes/articles$ diff --git a/DESCRIPTION b/DESCRIPTION index b0e6c55..47ab092 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,13 +1,13 @@ Package: whirl Title: Logging package -Version: 0.1.1 +Version: 0.1.2 Authors@R: c( person("Aksel", "Thomsen", , "oath@novonordisk.com", role = c("aut", "cre")), person("Lovemore", "Gakava", , "lvgk@novonordisk.com", role = "aut"), person("Cervan", "Girard", , "cgid@novonordisk.com", role = "aut"), person("Kristian", "Troejelsgaard", , "ktqn@novonordisk.com", role = "aut"), - person("Steffen Falgreen", family = "Larsen", email = "sffl@novonordisk.com", role = "aut"), - person(given = "VLOB (Vladimir Obucina)", role = "aut", email = "vlob@novonordisk.com"), + person("Steffen Falgreen", "Larsen", , "sffl@novonordisk.com", role = "aut"), + person("Vladimir", "Obucina", , email = "vlob@novonordisk.com", role = "aut"), person("Novo Nordisk A/S", role = "cph") ) Description: Provides functionalities for running R scripts in batch, while simultanously creating logs for each script execution. diff --git a/_pkgdown.yml b/_pkgdown.yml index 6763efd..6afc37b 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,4 +1,4 @@ -url: https://nn-opensource.github.io/whirl/ +url: https://novonordisk-opensource.github.io/whirl/ template: bootstrap: 5 diff --git a/man/whirl-package.Rd b/man/whirl-package.Rd index 02a8e07..782e7a3 100644 --- a/man/whirl-package.Rd +++ b/man/whirl-package.Rd @@ -27,7 +27,7 @@ Authors: \item Cervan Girard \email{cgid@novonordisk.com} \item Kristian Troejelsgaard \email{ktqn@novonordisk.com} \item Steffen Falgreen Larsen \email{sffl@novonordisk.com} - \item VLOB (Vladimir Obucina) \email{vlob@novonordisk.com} + \item Vladimir Obucina \email{vlob@novonordisk.com} } Other contributors: diff --git a/vignettes/example.Rmd b/vignettes/articles/example.Rmd similarity index 89% rename from vignettes/example.Rmd rename to vignettes/articles/example.Rmd index 78410ab..4cc61be 100644 --- a/vignettes/example.Rmd +++ b/vignettes/articles/example.Rmd @@ -1,12 +1,8 @@ --- title: "Log example" -output: rmarkdown::html_vignette -vignette: > - %\VignetteIndexEntry{Log example} - %\VignetteEngine{knitr::rmarkdown} - %\VignetteEncoding{UTF-8} --- + ```{r setup, include = FALSE} knitr::opts_chunk$set( collapse = TRUE, @@ -53,4 +49,3 @@ file.copy(from = "example_log.html", to = "../docs/articles") * [View summary log](summary.html) * [View log for example.R](example_log.html) * [The saved plot1.png](plot1.png) - diff --git a/vignettes/whirl.Rmd b/vignettes/whirl.Rmd index 106ff86..7a8c1e7 100644 --- a/vignettes/whirl.Rmd +++ b/vignettes/whirl.Rmd @@ -3,7 +3,7 @@ title: "Execute Scripts" output: rmarkdown::html_vignette vignette: > %\VignetteIndexEntry{Execute Scripts} - %\VignetteEngine{knitr::rmarkdown} + %\VignetteEngine{knitr::rmarkdown_notangle} %\VignetteEncoding{UTF-8} --- @@ -60,7 +60,7 @@ It is also possible to provide a character vector of several paths (either singl If the scripts have to be executed in a specific order, the `input` argument can be supplied as a list. The scripts will then be executed in the order they are listed in the list, with scripts listed in the same element being executed in parallel (if `n_workers` > 1). -```{r, eval = FALSE} +```{r} # In the below example, script1.R and script2.R will be executed in parallel run( input = c("path/to/script1.R", @@ -93,7 +93,7 @@ The list can also be supplied with names list elements. This can be useful during execution as some of these 'name' will be printed to the console. E.g. -```{r, eval = FALSE} +```{r} run(input = list( list( name = "Step 1", @@ -128,7 +128,7 @@ steps: In this case, the `input` argument in the `run()` function should point to the config file. Assuming the config file is called `config.yaml`, the execution can be initiated as follows: -```{r, eval = FALSE} +```{r} run(input = "path/to/config.yaml", n_workers = 4) ```