| Title: | Run Analysis Tools |
|---|---|
| Description: | A collection of tools to analyze model runs. |
| Authors: | Anastasis Giannousakis [aut, cre], Oliver Richters [aut] |
| Maintainer: | Anastasis Giannousakis <[email protected]> |
| License: | LGPL-3 |
| Version: | 0.22.1 |
| Built: | 2024-12-02 14:22:22 UTC |
| Source: | https://github.com/pik-piam/modelstats |
A collection of tools to analyze model runs.
Maintainer: Anastasis Giannousakis [email protected]
Authors:
Oliver Richters
Useful links:
What is the type of this run?
colRunType(mydir = ".")colRunType(mydir = ".")
mydir |
Path to the folder where the run is performed |
Anastasis Giannousakis
Is the run found in SLURM?
foundInSlurm(mydir = ".", user = NULL)foundInSlurm(mydir = ".", user = NULL)
mydir |
Path to the folder(s) where the run(s) is(are) performed |
user |
the user whose runs will be sought for |
Anastasis Giannousakis, Oliver Richters
Returns the current status of a run or a vector of runs
getRunStatus(mydir = dir(), sort = "nf", user = NULL)getRunStatus(mydir = dir(), sort = "nf", user = NULL)
mydir |
Path to the folder(s) where the run(s) is(are) performed |
sort |
how to sort (nf=newest first) |
user |
the user whose runs will be shown |
Anastasis Giannousakis
## Not run: a <- getRunStatus(dir()) ## End(Not run)## Not run: a <- getRunStatus(dir()) ## End(Not run)
Returns the output for getRunStatus nicely
loopRuns(mydir, user = NULL, colors = TRUE, sortbytime = TRUE)loopRuns(mydir, user = NULL, colors = TRUE, sortbytime = TRUE)
mydir |
a dir or vector of dirs |
user |
the user whose runs will be shown |
colors |
boolean whether the output is colored dependent on runstatus |
sortbytime |
boolean whether the output is sorted by timestamp |
Anastasis Giannousakis
## Not run: loopRuns(dir()) ## End(Not run)## Not run: loopRuns(dir()) ## End(Not run)
Runs a group of tests for a specific model. A "config/scenario_config.csv" file (relative) to the main folder has to exist in the model, describing the scenarios to be tested. Also, a gitlab repository is needed to push the generated README.md for documentation and automated reporting of test results.
modeltests( mydir = ".", gitdir = NULL, model = NULL, user = NULL, test = NULL, email = TRUE, compScen = TRUE, mattermostToken = NULL )modeltests( mydir = ".", gitdir = NULL, model = NULL, user = NULL, test = NULL, email = TRUE, compScen = TRUE, mattermostToken = NULL )
mydir |
Path to the folder where the model is found |
gitdir |
path to the git clone that sends the report via email |
model |
Model name |
user |
the user that starts the job and commits the changes |
test |
Use this option to run a test of the workflow (no runs will be submitted) The test parameter needs to be of the form "YY-MM-DD" |
email |
whether an email notification will be send or not |
compScen |
whether compScen has to run or not |
mattermostToken |
token used for mattermost notifications |
Anastasis Giannousakis, David Klein
Returns the output for getRunStatus nicely
printOutput(string, len1stcol = 67, lenCols = NULL, colSep = " ")printOutput(string, len1stcol = 67, lenCols = NULL, colSep = " ")
string |
String to print |
len1stcol |
length of first column |
lenCols |
vector with length information for all columns |
colSep |
string separating the columns |
Anastasis Giannousakis
prompts runs, will be called by rs2
promptAndRun(mydir = ".", user = NULL, daysback = 3)promptAndRun(mydir = ".", user = NULL, daysback = 3)
mydir |
a dir or vector of dirs |
user |
the user whose runs will be shown. For -t, the pattern used for matching |
daysback |
integer defining the number of days -c will look back in time to find runs |
Anastasis Giannousakis, Oliver Richters
## Not run: promptAndRun() ## End(Not run)## Not run: promptAndRun() ## End(Not run)