bayesmlogit (version 1.0.0)

life_compare: Compare life expectancies

Description

A function for comparing the life expectancies of subgroups. This function will, by default, calculate the percentage of samples in your reference group with a higher (or lower) life expectancy (or proportion of total life expectancy) than other groups.

Usage

life_compare(
  file_path,
  file = paste(file_path, "/mplotResults", sep = ""),
  state.include = 0,
  states,
  ref.var,
  ref.level,
  index.matrix,
  prop = TRUE,
  criterion = ">",
  state.names = NA
)

Value

A .csv file with comparison results.

Arguments

file_path

The file path for data reading. It can be inherited from mlifetable_plot().

file

The file path for outputs. Default is paste(file_path,"/mplotResults",sep='').

state.include

The status we aim to compare. It can be a number or a vector. Default is 0, which means we'll consider all states. It can be inherited from mlifetable_plot().

states

The total number of states in data. It can be inherited from mlifetable_plot().

ref.var

A vector containing all covariates used as comparison factors for each subgroup.

ref.level

A vector that declares the reference value of each reference variable.

index.matrix

A matrix that generated in mlifeTable_plot(). You don't need to specify it when using mlifeTable_plot().

prop

If TRUE, this function will output the comparision reulsts of life expectancy proportions in addition to orginal comparison results. Default is TRUE. It can be inherited from mlifetable_plot().

criterion

The criterion for comparison, which can be either ">" or "<". Default is ">".

state.names

A vector used to specify names of each state except death. It can be inherited from mlifetable_plot().

See Also

mlifeTable_plot

Examples

# \donttest{

#By setting the parameter 'compare' in mlifeTable_plot() to TRUE. 
#We can directly employ this function.

mlifeTable_plot(X=lifedata[,-1],state.include = 3,
      groupby = c("male","black","hispanic"), 
      cred = 0.84, 
      states = 3,
      file_path = ".",
      compare = TRUE,
      ref.var = c("black","hispanic"),
      ref.level = c(0,0))

# }