mtkRandLHSDesigner-class: The 'mtkRandLHSDesigner' class

In mtk: Mexico ToolKit library (MTK)

Description

The mtkRandLHSDesigner class is a sub-class of the class mtkDesigner. It implements the method RandLHS and provides all the slots and methods defined in the class mtkDesigner.

Class Hierarchy

Parent classes :

mtkDesigner

Direct Known Subclasses :

Constructor

mtkRandLHSDesigner

signature(mtkParameters = NULL, listParameters = NULL)

Slots

name:

(character) always takes the string "design".

protocol:

(character) always takes the string "R".

site:

(character) always takes the string "mtk".

service:

(character) always takes the string "RandLHS".

parameters:

(vector) a vector of [mtkParameter] containing the parameters to pass while calling the service.

ready:

(logical) a logical to tell if the process is ready to run.

state:

(logical) a logical to tell if the results produced by the process are available and ready to be consumed.

result:

(ANY) a data holder to hold the results produced by the process

Methods

setName

signature(this = "mtkRandLHSDesigner", name = "character"): Not used, method inherited from the parent class.

setParameters

signature(this = "mtkRandLHSDesigner", f = "vector"): Assigns new parameters to the process.

getParameters

signature(this = "mtkRandLHSDesigner"): Returns the parameters as a named list.

is.ready

signature( = "mtkRandLHSDesigner"): Tests if the process is ready to run.

setReady

signature(this = "mtkRandLHSDesigner", switch = "logical"): Makes the process ready to run.

is.ready

signature( = "mtkRandLHSDesigner"): Tests if the results produced by the process are available.

setReady

signature(this = "mtkRandLHSDesigner", switch = "logical"): Marks the process as already executed.

getResult

signature(this = "mtkRandLHSDesigner"): Returns the results produced by the process as a [mtkRandLHSDesignerResult].

getData

signature(this = "mtkRandLHSDesigner"): Returns the results produced by the process as a data.frame.

serializeOn

signature(this = "mtkRandLHSDesigner"): Returns all data managed by the process as a named list.

run

signature(this = "mtkRandLHSDesigner", context= "mtkExpWorkflow"): Generates the experimental design by sampling the factors.

summary

signature(object = "mtkRandLHSDesigner"): Provides a summary of the results produced by the process.

print

signature(x = "mtkRandLHSDesigner"): Prints a report of the results produced by the process.

plot

signature(x = "mtkRandLHSDesigner"): Plots the results produced by the process.

report

signature(this = "mtkRandLHSDesigner"): Reports the results produced by the process.

See Also

package?lsh, help(LHS)

Examples

# To do, example for LHS method

mtk documentation built on May 2, 2019, 4:15 a.m.