tableBuilder: Returns a dataset for use in a table by the Table Builder...

In kcha193/simarioV2: Discrete-time Dynamic Micro-simulation Framework for R

Returns a dataset for use in a table by the Table Builder GUI.

Description

Currently cannot do freqs for final outcomes (can only do freqs for those vars with binbreaks) Also currently can only use a true categorical variable as a groupby variable - this coould be changed.

Usage

tableBuilder(
  env,
  statistic = c("frequencies", "means", "quantiles"),
  variableName,
  dict = env$dict,
  grpbyName = "",
  CI = TRUE,
  logisetexpr = "",
  envBase = NULL,
  basePop = FALSE,
  digits = 1
)

Arguments

statistic	the summary measure to use in producing the dataset - frequencies, means, quantiles
variableName	the variable to use in producing the dataset
dict	Dictionary object.
grpbyName	a subgroup by which to examine the variable
CI	logical indicating whether 95% confidence intervals should be generated
logisetexpr	a character expression which defines the logiset variable
basePop	logical which to allow the users to used the base population
digits	integer indicating the number of decimal places
envName	the environment to use - Base, Scenario etc.
binbreaks	The binbreaks for the outcome variable.
env.base	Base simulation results

Details

If the user defined a logiset/subgroup expression inthe scenario weightings screen and then goes to tableBuilder() and sets a grpbyName, then the results they get will be on the entire dataset, not just on their subgroup they defined earlier. The user can not define a logiset expression in tableBuilder - the logisetexpr parameter is there so it can be used to show the user, in the scenario weightings screen, the distributions of the variable of interest for their subgroup only so they can better choose the proportions for their subgroup scenario.

Value

a summary table for the entire or subgroup of the variable of interest.

kcha193/simarioV2 documentation built on April 8, 2024, 4:51 p.m.