Learn R Programming

rdecision (version 1.1.2)

Reaction: A reaction (chance) edge in a decision tree

Description

An R6 class representing a reaction (chance) edge in a decision tree.

Arguments

Author

Andrew J. Sims andrew.sims@newcastle.ac.uk

Super classes

rdecision::Edge -> rdecision::Arrow -> Reaction

Methods

Inherited methods


Method new()

Create an object of type Reaction. A probability must be assigned to the edge. Optionally, a cost and a benefit may be associated with traversing the edge. A pay-off (benefit-cost) is sometimes used in edges of decision trees; the parametrization used here is more general.

Usage

Reaction$new(source, target, p, cost = 0, benefit = 0, label = "")

Arguments

source

Chance node from which the arrow leaves.

target

Node which the arrow enters.

p

Probability

cost

Cost associated with traversal of this edge.

benefit

Benefit associated with traversal of the edge.

label

Character string containing the arrow label.

Returns

A new Reaction object.


Method modvars()

Find all the model variables of type ModVar that have been specified as values associated with this Action. Includes operands of these ModVars, if they are expressions.

Usage

Reaction$modvars()

Returns

A list of ModVars.


Method p()

Return the current value of the edge probability, i.e. the conditional probability of traversing the edge.

Usage

Reaction$p()

Returns

Numeric value in range [0,1].


Method cost()

Return the cost associated with traversing the edge.

Usage

Reaction$cost()

Returns

Cost.


Method benefit()

Return the benefit associated with traversing the edge.

Usage

Reaction$benefit()

Returns

Benefit.


Method clone()

The objects of this class are cloneable with this method.

Usage

Reaction$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Details

A specialism of class Arrow which is used in a decision tree to represent edges whose source nodes are ChanceNodes.