CARMS (version 1.0.1)

carms.base: Modify an "carms" Object adding a base element

Description

This function establishes a base rate that can be called, often in multiples or combination, during transition definition.

Usage

carms.base(x, value, time_units=NULL, base_label=NULL, description="")

Value

The input object will be returned with the addition this base information in the "carms$base" list element. Also, any base_label provided will be added to the "carms$base" list element as well.

Arguments

x

An "carms" object as initialized by carms.make and modified only by previous carms.state or carms.base calls

value

A rate value

time_units

A string establishing the units of time measure. This value is requried on only the first carms.base call on a carms object. It will be ignored in subsequent carms.base calls. The units string provided here will be used for the x-axis label of the simulation plot.

base_label

An optional string that can be used as a valid R object name holding this value.

description

An optional string providing more information about the base (never seen on diagram nor plot).

References

Jan Pukite and Paul Pukite (1998), "Modeling for Reliability Analysis", IEEE Press, New York

William J. Stewart (1994), "Introduction to the numerical solution of Markov chains", Princeton University Press, Princeton

Examples

	SiSimpl<-carms.make(title="Parallel            Identical components", diagram_grid=c(5,8))
	SiSimpl<-carms.state(SiSimpl, prob=1, name="P1", size=7, h2w=14/20, position=c(2,3) )
	SiSimpl<-carms.state(SiSimpl, prob=0, name="P2", size=7, h2w=14/20, position=c(6,3) )	
	SiSimpl<-carms.base(SiSimpl, 1, time_units="hours",  description="Failure rate")