bayesmlogit (version 1.0.0)

mlifeTable_plot: Plot life expectancies

Description

A function for plotting posterior means and their credible intervals. It can also be used as a subfunction in mlifetable().

Usage

mlifeTable_plot(
  state.include = 0,
  groupby,
  file_path,
  X,
  cred = 0.84,
  states,
  prop = TRUE,
  subgroup.names = NULL,
  state.names = NA,
  compare = FALSE,
  midpoint.type = "mean",
  ...
)

Value

Plots and tables for posterior means and credible intervals of each subgroups.

Arguments

state.include

A vector or a number used to specify the states whose expectancy years are of interest. Default is 0, which means we'll generate plots for all states. For multiple states specified, we will get the expectancy years for each state and their sum.

groupby

A vector that contains covariates for subgroup comparisons. It can be inherited from mlifetable().

file_path

The file path for outputs. It can be inherited from mlifetable().

X

A matrix of covariates. Note that X must include age as a convariate. It can be inherited from mlifetable().

cred

Credible level. For example, if cred = 0.84, we will get the 84% credible interval.

states

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

prop

If TRUE, this function will output life expectancy proportion plots and tables in addition to original life expectancy plots. Default is TRUE.

subgroup.names

A vector that contains names of each subgroup. You can also specify them in the output files.

state.names

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

compare

If TRUE, this function will quote life_compare() and generate a table with all comparsion results based on the reference variables and reference levels specified. Default is FALSE.

midpoint.type

A character used to specify the midpoint type for credible interval plots. Can be either "mean" or "median". Default is "mean", which means the plots will use mean values as the middle point.

...

Extra parameters for life_compare(). See details using ?life_compare().

See Also

mlifeTable, life_compare

Examples

# \donttest{

#Generate plots and corresponding tables only.
mlifeTable_plot(X=lifedata[,-1],state.include = 0,
      groupby = c("male","black","hispanic"), 
      cred = 0.84, 
      states = 3,
      file_path = ".")
      
#Additionally generate the comparsion results to the reference level.
mlifeTable_plot(X=lifedata[,-1],state.include = 0,
      groupby = c("male","black","hispanic"), 
      cred = 0.84, 
      states = 3,
      file_path = ".",
      compare = TRUE,
      ref.var = c("black","hispanic"),
      ref.level = c(0,0))
# }