mcwr_switch: Switch from-state and target state

In mcwr: Markov Chains with Rewards

Description

Change from-state and target state index convention of variable names

Usage

mcwr_switch(data, ji = as.logical(NA), verbose = FALSE)

Arguments

data	an mcwr data.frame
ji	boolean TRUE/FALSE. If TRUE, the data frame will always be in ji-format after function conclusion. That is, if the data are in ij-format they will be converted to ji-format, and will be left untouched otherwise.
verbose	boolan TRUE/FALSE. If TRUE, the function will display verbose error messages. This is useful if the function tells you that it can neither find a consistent ji data frame nor a consistent ij data frame. The error messages under option verbose may give you a clue about the source of the error.

Details

The appendix notation follows the ij-notation, where the first index refers to the target state and the second index to the from-state. This has the advantage of conforming with the conventions of matrix algebra. p- and r-variables of mcwr data frames, however, generally follow the ji-convention. The advantage of this is that sorting the variables alphabetically results in a sensible and intuitive ordering. Therefore, your data frame variables are required to follow the ji-convention. The convenience function mcwr_switch() allows you to switch between the two conventions. If you have a consistent data frame in ij-format, running this function will rename variables according to the ji-convention. Your data must be in ji-format before you can run any other of the mcwr functions. As a brief example, we load data in ji-format, then switch to ij-format and back:

Value

A data.frame, suitable for further processing by mcwr_*() functions.

See Also

Other mcwr: mcwr_check(), mcwr_exit(), mcwr_expectancies(), mcwr_genvars()

Examples

data <- mcwr_exampledata(1)
head(data)
data <- mcwr_switch(data)
head(data)
data <- mcwr_switch(data)
head(data)

mcwr documentation built on March 11, 2021, 1:06 a.m.