Skip to content

Commit

Permalink
fix: spelling errors
Browse files Browse the repository at this point in the history
  • Loading branch information
akselthomsen committed Dec 18, 2024
1 parent 70b8296 commit 5188fef
Show file tree
Hide file tree
Showing 9 changed files with 22 additions and 28 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@
^whirl.*\.tgz$
^whirl\.Rcheck$
^whirl\.Rproj$
^înst/WORDLIST$
plot1.png
summary.html
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Authors@R: c(
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.
Description: Provides functionalities for running R scripts in batch, while simultaneously creating logs for each script execution.
License: Apache License (>= 2)
URL: https://novonordisk-opensource.github.io/whirl/, https://github.com/novonordisk-opensource/whirl
Depends:
Expand Down
10 changes: 5 additions & 5 deletions R/options.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ NULL
options::define_option(
option = "out_formats",
default = "html",
desc = "Which log format(s) to produce. Possiblities are `html`, `json`, and
desc = "Which log format(s) to produce. Possibilities are `html`, `json`, and
markdown formats: `gfm`, `commonmark`, and `markua`."
)

Expand Down Expand Up @@ -54,7 +54,7 @@ options::define_option(
options::define_option(
option = "track_files_keep",
default = paste0("^", getwd()),
desc = "List of file naming patterns alway to be tracked when
desc = "List of file naming patterns always to be tracked when
track_files = TRUE",
envvar_fn = options::envvar_str_split(delim = ";")
)
Expand Down Expand Up @@ -83,15 +83,15 @@ options::define_option(
options::define_option(
option = "n_workers",
default = 1,
desc = "Number of simultanous workers used in the run function.
desc = "Number of simultaneous workers used in the run function.
A maximum of 128 workers is allowed."
)

options::define_option(
option = "log_dir",
default = dirname,
desc = "The output directory of the log files. Default is the folder of the
excuted script. log_dir can be a path as a character or it can be a function
executed script. log_dir can be a path as a character or it can be a function
that takes the script path as input and returns the log directory.
For more information see the examples of `run()` or `vignette('whirl')`."
)
Expand All @@ -100,7 +100,7 @@ options::define_option(
option = "execute_dir",
default = NULL,
desc = "The working directory of the process executing each script.
Defeault us to execute R files from the working directory when calling `run()`
Default us to execute R files from the working directory when calling `run()`
and all other functions from the directory of the script. To change provide
a character path (used for all scripts) or a function that takes the script
as input and returns the execution directory."
Expand Down
7 changes: 0 additions & 7 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Aksel
alway
aut
callr
Cervan
Expand All @@ -10,12 +9,9 @@ config
Config
cph
cre
Defeault
dev
dir
dplyr
exampel
excuted
Falgreen
Gakava
getenv
Expand Down Expand Up @@ -48,7 +44,6 @@ OpenSource
overwritable
PKGS
pkgs
Possiblities
pre
purrr
README
Expand All @@ -63,8 +58,6 @@ RoxygenNote
sessioninfo
setenv
sffl
simultanous
simultanously
Steffen
stringr
Sys
Expand Down
10 changes: 5 additions & 5 deletions man/options.Rd

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

10 changes: 5 additions & 5 deletions man/options_params.Rd

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

6 changes: 3 additions & 3 deletions man/run.Rd

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

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.

2 changes: 1 addition & 1 deletion vignettes/whirl.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,6 @@ run(
)
```

In this exampel the log of script1.R will be stored in **path/to/dir1/logs** and the log of script2.R will be stored in **path/to/dir2/logs**.
In this example the log of script1.R will be stored in **path/to/dir1/logs** and the log of script2.R will be stored in **path/to/dir2/logs**.

Note that **x** refer to the path of the script that is being executed.

0 comments on commit 5188fef

Please sign in to comment.