Skip to contents

OpenM++ Workset Class

Source: R/ClassWorkset.R
load_workset.Rd

OpenM++ Workset Class

Usage

load_workset(model, set)

load_scenario(model, set)

Arguments

model

Model digest or model name.

set

Name of workset (input set of model parameters).

Value

An OpenMppWorkset instance.

Details

load_scenario() is an alias for load_workset().

Super class

openmpp::OpenMppModel -> OpenMppWorkset

Public fields

WorksetName

Workset name.

WorksetMetadata

Workset metadata.

OpenMppType

OpenM++ object type (used for print()).

Parameters

Workset parameters.

Active bindings

ReadOnly

Workset read-only status.

BaseRunDigest

Base run digest for input parameters.

Methods

Public methods

Method new()

Create a new OpenMppWorkset object.

Usage

OpenMppWorkset$new(model, set)

Arguments

model

Model digest or name.

set

Workset name.

Returns

A new OpenMppWorkset object.

Method print()

Print a OpenMppWorkset object.

Usage

OpenMppWorkset$print(...)

Arguments

...

Not currently used.

Returns

Self, invisibly.

Method set_base_digest()

Set the base run digest.

Usage

OpenMppWorkset$set_base_digest(base)

Arguments

base

Base run digest.

Returns

Self, invisibly.

Method delete_base_digest()

Delete the base run digest.

Usage

OpenMppWorkset$delete_base_digest()

Returns

Self, invisibly.

Method copy_params()

Copy parameters from a base scenario.

Usage

OpenMppWorkset$copy_params(names)

Arguments

names

Character vector of parameter names.

Returns

Self, invisibly.

Method delete_params()

Delete parameters from scenario.

Usage

OpenMppWorkset$delete_params(names)

Arguments

names

Character vector of parameter names.

Returns

Self, invisibly.

Method get_param()

Retrieve a parameter.

Usage

OpenMppWorkset$get_param(name)

Arguments

name

Parameter name.

Returns

A tibble.

Method set_param()

Set a parameter.

Usage

OpenMppWorkset$set_param(name, data)

Arguments

name

Parameter name.

data

New parameter data.

Returns

Self, invisibly.

Method run()

Initiate a model run for the model workset/scenario.

Usage

OpenMppWorkset$run(
  name,
  opts = opts_run(),
  wait = FALSE,
  wait_time = 0.2,
  progress = TRUE
)

Arguments

name

Run name.

opts

Run options. See opts_run() for more details.

wait

Logical. Should we wait until the model run is done?

wait_time

Number of seconds to wait between status checks.

progress

Logical. Should a progress bar be shown?

Returns

Self, invisibly.