models: Model archetype

modelsR Documentation

Model archetype

Description

[Experimental]

Usage

model_archetype(x = unspecified(), ...)

## S3 method for class 'lm'
model_archetype(
  x,
  name = deparse(substitute(x)),
  label = list(),
  role = list(),
  fmls = summon_formulas(),
  description = character(),
  strata_info = stats::formula(),
  ...
)

## S3 method for class 'glm'
model_archetype(
  x,
  name = deparse(substitute(x)),
  label = list(),
  role = list(),
  fmls = summon_formulas(),
  description = character(),
  strata_info = stats::formula(),
  ...
)

## S3 method for class 'coxph'
model_archetype(
  x,
  name = deparse(substitute(x)),
  label = list(),
  role = list(),
  fmls = summon_formulas(),
  description = character(),
  strata_info = stats::formula(),
  ...
)

## S3 method for class 'model_fit'
model_archetype(
  x,
  name = deparse(substitute(x)),
  label = list(),
  role = list(),
  fmls = summon_formulas(),
  description = character(),
  strata_info = stats::formula(),
  ...
)

## S3 method for class 'list'
model_archetype(
  x,
  name = deparse1(substitute(x)),
  label = list(),
  role = list(),
  fmls = summon_formulas(),
  description = character(),
  strata_info = stats::formula(),
  ...
)

## Default S3 method:
model_archetype(x = unspecified(), ...)

mx(x = unspecified(), ...)

Arguments

strata_info

User-defined formula, with the LHS being the column representing the strata, and the RHS being the level used in the model. For example, am ~ 0 in the mtcars data, the model was subset for only cars that did not have automatic transmission named in the am variable.


asshah4/axe documentation built on Nov. 9, 2022, 12:45 a.m.