ExpDes: ExpDes: Create an experimental design using an hmvars object.

Description Usage Arguments Details Value

View source: R/05_hmsetup.R

Description

This function reads parameters in the hmvars object as a function of variable name, and uses them in constructing an experimental design.

Usage

1
2
ExpDes(obj = NULL, edtype = "augfpb", ncases = NULL, basedir = "tmp",
  objname = obj$template_name, ...)

Arguments

obj

The name of an hmvars object.

edtype

The type of experimental design. This should be one of c("pb", "fpb", "augfpb", "lhs").

  • pb Plackett-Burman. (FrF2::pb)

  • fpb Folded Plackett-Burman. (FrF2::fold.design)

  • augfpb Folded Plackett-Burman augmented with a latin hypercube spacefilling design. This is the default. (lhs::optAugmentLHS)

  • lhs A latin hypercube spacefilling design. (lhs::improvedLHS)

ncases

The desired number of cases to be run. This value only constrains the spacefilling portion of the design.

basedir

The path to the base directory of a simulation project. The default is a subdirectory of the current directory called "tmp". This is used to store the edited object.

objname

This is used to save the edited object to a file. It defaults to the name of the hmvars object.

...

Arguments passed to the underlying experimental design functions.

Details

The "ncases" value only constrains the spacefilling portion of the design. The default of 10 times the number of variables is a common rule of thumb for spacefilling designs. When "augfpb" is chosen, the number of cases for the "fpb" design is subtracted from the "ncases" value, and this remainder is the number of points that will be augmented with a spacefilling design.

Value

Returns a template object, and writes out a template object file.


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