# Create health states tables

Source: `R/model-setup.R`
`create_states.Rd`

Create a data table describing the health states for the model.

    create_states(object)

## Arguments

object | A `model_structure` object.

## Value

A data table with the following columns:

state_id

  The state ID number.

state_name

  The state name,

state_name_long

  A long-form state name.

## Examples

    txseq1 <- txseq(first = "erlotinib",
                   second = c("osimertinib", "PBDC"),
                   second_plus = c("PBDC + bevacizumab", "PBDC + bevacizumab"))
    txseq2 <- txseq(first = "gefitinib",
                   second = c("osimertinib", "PBDC"),
                   second_plus = c("PBDC + bevacizumab", "PBDC + bevacizumab"))
    txseqs <- txseq_list(seq1 = txseq1, seq2 = txseq2)

    struct1 <- model_structure(txseqs, n_states = "four")
    create_states(struct1)#>    state_id state_name                       state_name_long
    #> 1:        1         S1                        Stable with 1L
    #> 2:        2      P1/S2 Progression with 1L -> Stable with 2L
    #> 3:        3         P2                   Progression with 2L
    #> 4:        4          D                                 Death
    struct2 <- model_structure(txseqs, n_states = "three")
    create_states(struct2)#>    state_id state_name     state_name_long
    #> 1:        1         S1      Stable with 1L
    #> 2:        2      P1/S2 Progression with 1L
    #> 3:        3          D               Death
    txseqs <- txseq_list(seq1 = txseq1, seq2 = txseq2,
                         start_line = "second", mutation = "negative")
    struct3 <- model_structure(txseqs, n_states = "three")
    create_states(struct3)#>    state_id state_name     state_name_long
    #> 1:        1      P1/S2      Stable with 2L
    #> 2:        2         P2 Progression with 2L
    #> 3:        3          D               Death