Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: R CMD BUILD of vignettes #104

Merged
merged 6 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ plot1.png
^whirl\.Rcheck$
^whirl.*\.tar\.gz$
^whirl.*\.tgz$
^vignettes/articles$
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
Package: whirl
Title: Logging package
Version: 0.1.1
Version: 0.1.2
Authors@R: c(
person("Aksel", "Thomsen", , "[email protected]", role = c("aut", "cre")),
person("Lovemore", "Gakava", , "[email protected]", role = "aut"),
person("Cervan", "Girard", , "[email protected]", role = "aut"),
person("Kristian", "Troejelsgaard", , "[email protected]", role = "aut"),
person("Steffen Falgreen", family = "Larsen", email = "[email protected]", role = "aut"),
person(given = "VLOB (Vladimir Obucina)", role = "aut", email = "[email protected]"),
person("Steffen Falgreen", "Larsen", , "[email protected]", role = "aut"),
person("Vladimir", "Obucina", , email = "[email protected]", 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.
Expand Down
2 changes: 1 addition & 1 deletion _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
url: https://nn-opensource.github.io/whirl/
url: https://novonordisk-opensource.github.io/whirl/

template:
bootstrap: 5
Expand Down
2 changes: 1 addition & 1 deletion man/whirl-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 1 addition & 6 deletions vignettes/example.Rmd → vignettes/articles/example.Rmd
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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)

8 changes: 4 additions & 4 deletions vignettes/whirl.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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}
---

Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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)
```

Expand Down
Loading