associate.schema.comparison
Associate Schema: Comparison
Description
associate.schema.comparison defines the summary-table contract used by associate$compare().
Comparison rows describe formal tests or contrasts between models, effects, or groups. Some rows are coefficient-like and can be visualized with forest or heatmap plots directly. Omnibus rows may not have a meaningful estimate, in which case estimate, se, lower, and upper may be NA while the inferential result is carried by statistic, degrees of freedom, and p.value.
Usage
associate.schema.comparison
Format
An object of class environment of length 6.
Value
An environment with the developer-facing methods:
-
required() -
optional() -
empty() -
row(…) -
validate(results)
Required columns
The comparison schema requires:
-
family -
outcome -
predictor -
groups.by -
comparison.type -
comparison.test -
term -
term.type -
contrast -
stratum -
fit.id -
formula -
estimate -
se -
lower -
upper -
statistic -
p.value -
adj.p.value -
n
Optional columns
Optional columns include:
-
effect.scale -
reference -
df -
df1 -
df2 -
n.events -
n.competing -
fit.base -
fit.full
Row types
term.type should typically be one of:
-
contrast -
interaction -
group -
omnibus
Artifacts
Common comparison artifacts include:
-
model.comparison -
component.estimates -
contrast.table -
curves -
risk.table -
group.summary
Validation
associate.schema.comparison$validate() checks only for the required columns. Interpretation of optional columns depends on the comparison family and comparison type.