prCaGetVnStats: Gets the variable stats

In Greg: Regression Helper Functions

Gets the variable stats

Description

Gets the variable stats

Usage

prCaGetVnStats(
  model,
  vn,
  outcome,
  ds,
  add_references,
  add_references_pos,
  desc_args
)

Arguments

model	The model
vn	The variable name
outcome	The outcome vector
ds	The dataset
add_references	True if it should use the data set to look for references, otherwise supply the function with a vector with names. Sometimes you want to indicate the reference row for each group. This needs to be just as many as the groups as the order identified. Use NA if you don't want to have a reference for that particular group.
add_references_pos	The position where a reference should be added. Sometimes you don't want the reference to be at the top, for instance if you have age groups then you may have < 25, 25-39, 40-55, > 55 and you have the reference to be 25-39 then you should set the reference list for age_groups as add_references_pos = list(age_groups = 2) so that you have the second group as the position for the reference.
desc_args	The description arguments that are to be used for the the description columns. The options/arguments should be generated by the caDescribeOpts function.

Value

matrix A matrix from getDescriptionStatsBy or prGetStatistics

See Also

Other printCrudeAndAdjusted functions: prCaAddRefAndStat(), prCaAddReference(), prCaAddUserReferences(), prCaGetImputationCols(), prCaGetRowname(), prCaPrepareCrudeAndAdjusted(), prCaReorderReferenceDescribe(), prCaReorder(), prCaSelectAndOrderVars(), prCaSetRownames()

Greg documentation built on Nov. 16, 2022, 5:06 p.m.