Package 'modelstats'

modelstats: Run Analysis Tools

Description

A collection of tools to analyze model runs.

Author(s)

Maintainer: Anastasis Giannousakis [email protected]

Authors:

• Anastasis Giannousakis [email protected]

• Oliver Richters

See Also

Useful links:

• https://github.com/pik-piam/modelstats

• Report bugs at https://github.com/pik-piam/modelstats/issues

---

colRunType

Description

What is the type of this run?

Usage

colRunType(mydir = ".")

Arguments

mydir

Path to the folder where the run is performed

Author(s)

Anastasis Giannousakis

---

Provide a command line interface to loopRuns and getSanityChecks

Description

This function is made to be called by the rs tool. It takes the command line arguments supplied by the user when calling rs, evaluates them, and according to them prepares the arguments finally passed to loopRuns or getSanityChecks.

Usage

commandLineInterface(argv)

Arguments

argv	A character vector containing the command line arguments.

Value

A string containing the status or sanity table.

Author(s)

David Klein

---

foundInSlurm

Description

Is the run found in SLURM?

Usage

foundInSlurm(mydir = ".", user = NULL)

Arguments

mydir	Path to the folder(s) where the run(s) is(are) performed
user	the user whose runs will be sought for

Author(s)

Anastasis Giannousakis, Oliver Richters

---

getRunStatus

Description

Returns the current status of a run or a vector of runs

Usage

getRunStatus(mydir = dir(), sort = "nf", user = NULL)

Arguments

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

Author(s)

Anastasis Giannousakis

Examples

## Not run: 

a <- getRunStatus(dir())

## End(Not run)

---

getSanityChecks

Description

Get overview of sanity check results for a list of REMIND runs

Usage

getSanityChecks(dirs = NULL)

Arguments

dirs	a vector of paths to REMIND runs. When NULL, the latest AMTs are used (only works on PIK cluster)

Details

Currently the following columns are printed:

• SumErr Summation Errors found when running remind2::convGDX2MIF

• RangeErr Range Errors found when running remind2::convGDX2MIF

• FixingErr Fixing Errors found when running piamInterfaces::fixOnRef

• MissingVar Missing Variables found when running piamInterfaces::checkMissingVars for ScenarioMIP

• ProjSumErr Summation Errors found when running piamInterfaces::checkSummations for ScenarioMIP

• ProjSumErrReg Regional Summation Errors found when running piamInterfaces::checkSummationsRegional for ScenarioMIP

Author(s)

Falk Benke

---

loopRuns

Description

Returns the output for getRunStatus nicely

Usage

loopRuns(mydir, user = NULL, colors = TRUE, sortbytime = TRUE)

Arguments

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

Author(s)

Anastasis Giannousakis

Examples

## Not run: 

loopRuns(dir())

## End(Not run)

---

modeltests

Description

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.

Usage

modeltests(
  mydir = ".",
  gitdir = NULL,
  model = NULL,
  user = NULL,
  email = TRUE,
  compScen = TRUE,
  mattermostToken = NULL
)

Arguments

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
email	whether an email notification will be send or not
compScen	whether compScen has to run or not
mattermostToken	token used for mattermost notifications

Author(s)

Anastasis Giannousakis, David Klein

See Also

package2readme

---

printOutput

Description

Returns the output for getRunStatus nicely

Usage

printOutput(
  string,
  len1stcol = 67,
  lenCols = NULL,
  colSep = "   ",
  cols = NULL
)

Arguments

string	list with information to print
len1stcol	length of first column
lenCols	vector with length information for all columns
colSep	string separating the columns
cols	optional vector of elements to retrieve from the passed list. Default NULL corresponds to a predefined set of elements.

Author(s)

Anastasis Giannousakis, Falk Benke

---

promptAndRun

Description

prompts runs, will be called by rs2

Usage

promptAndRun(mydir = ".", user = NULL, daysback = 3)

Arguments

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

Author(s)

Anastasis Giannousakis, Oliver Richters

Examples

## Not run: 
  promptAndRun()

## End(Not run)

---