utility.endnode.classcounts.create: Construct an end node that evaluates counts in different...

View source: R/utility.endnode.classcounts.r

utility.endnode.classcounts.createR Documentation

Construct an end node that evaluates counts in different quality classes.

Description

Function to construct a node that evaluates counts in different quality classes by assigning a value to the highest class with counts > 0 and optionally increments this value with the counts in this and lower classses and given increments per count unit. The user can choose whether these increments can lead to a value higher than the basic value for counts in the next better class or if this value limits the potential increase.

Usage

utility.endnode.classcounts.create(name.node,        # character(1)
                                   name.attrib,      # character(n)
                                   u.max.inc,        # list (n) of vect (>=1)
                                   names.u.max.inc = list(),
                                   exceed.next     = TRUE,
                                   utility         = TRUE,
                                   required        = FALSE,
                                   col             = "black",
                                   shift.levels    = 0)

Arguments

name.node

name of the node to be constructed as a character string.

name.attrib

vector of names of attributes (counts in classes in decreasing order of value of the classes).

u.max.inc

list of vectors specifying the basic value and the increments for each class and classes of less value.

names.u.max.inc

(optional) list of vectors of names of parameters u.max.inc.

exceed.next

(optional) logical variable to indicate whether the level corresponding to the species classified at the next higher level can be exceeded with increments; default value is TRUE.

utility

(optional) logical variable indicating if a value function (FALSE) or a utility function (TRUE) is created. Default value is TRUE.

required

(optional) logical variable indicating if the value of this node is required for aggregation at the next higher level. If this variable is TRUE, aggregation at the next higher level is not possible if this node returns NA. Default value is FALSE.

col

(optional) color used for plotting the bounding box of the node in the objective hierarchy. Default value is "black".

shift.levels

(optional) number of hierarchical levels by which the node in the objective hierarchy is shifted to make a branch fit better to other branches. Default value is 0.

Value

The function returns the created object of type utility.endnode.classcounts with the properties specified in the arguments of the function.

Author(s)

Peter Reichert <peter.reichert@emeriti.eawag.ch>

References

Short description of the package:

Reichert, P., Schuwirth, N. and Langhans, S., Constructing, evaluating and visualizing value and utility functions for decision support, Environmental Modelling & Software 46, 283-291, 2013.

Textbooks on the use of utility and value functions in decision analysis:

Keeney, R. L. and Raiffa, H. Decisions with Multiple Objectives - Preferences and Value Tradeoffs. John Wiley & Sons, 1976.

Eisenfuehr, F., Weber, M. and Langer, T., Rational Decision Making, Springer, Berlin, 2010.

See Also

Print, evaluate and plot the node with

print.utility.endnode.classcounts,
summary.utility.endnode.classcounts,
evaluate.utility.endnode.classcounts and
plot.utility.endnode.classcounts.

Create other end nodes with

utility.endnode.discrete.create,
utility.endnode.intpol1d.create,
utility.endnode.parfun1d.create,
utility.endnode.intpol2d.create, or
utility.endnode.cond.create,
utility.endnode.firstavail.create,

Create other types of nodes with

utility.aggregation.create,
utility.conversion.intpol.create, or
utility.conversion.parfun.create.


utility documentation built on Aug. 28, 2023, 1:07 a.m.