BuildDecks: BuildDecks: Create a set of decks using a deck template and...

Description Usage Arguments Details Value

View source: R/05_hmsetup.R

Description

This function reads an experimental design from a hmvars object and combines it with the appropriate deck template to create a series of decks implementing the experimental design.

Usage

1
2
BuildDecks(obj, template, basedir = "tmp", overwrite = FALSE,
  cases = NULL)

Arguments

obj

The name of an hmvars object.

template

The deck template associated with the hmvars object.

basedir

The path to the base directory of a simulation project. The default is a subdirectory of the current directory called "tmp".

overwrite

TRUE means overwrite all; FALSE (the default) means don't overwrite anything; NULL means overwrite decks older than the hmvars object.

cases

The default is NULL, meaning create a deck for all of the cases in the experimental design. Alternatively, a list of line numbers in the experimental design for the desired cases may be submitted.

Details

FALSE is the default for overwrite because this would seem to be the most common use case. One would expect to create a design, build decks, and run some cases. After looking as the results and thinking a little, one would add some cases to the experimental design and run some more cases. If the old decks that you have already run were overwritten, they would have a newer file date than the results from the previous runs, and they would be run again.

Value

Returns a list of deck files suitable for use in submitting the cases


gerwathome/runOPM documentation built on May 20, 2019, 4:05 p.m.