PolyGeniusAssociations

Association result container

Description

PolyGeniusAssociations() constructs the standard result object returned by association workflows. The object is a lightweight S3 list with six public fields: ⁠$results⁠, ⁠$artifacts⁠, ⁠$schemas⁠, ⁠$diagnostics⁠, ⁠$metadata⁠, and ⁠$models⁠.

Usage

PolyGeniusAssociations(
  results = NULL,
  artifacts = list(),
  schemas = list(),
  diagnostics = NULL,
  metadata = list(),
  models = list(),
  ...
)

print.PolyGeniusAssociations(x, ...)

summary.PolyGeniusAssociations(object, ...)

## S3 method for class 'PolyGeniusAssociations'
as.data.frame(x, row.names = NULL, optional = FALSE, ...)

## S3 method for class 'PolyGeniusAssociations'
as.data.table(x, ...)

## S3 method for class 'PolyGeniusAssociations'
plot(x, ...)

## S3 method for class 'PolyGeniusAssociations'
x[i, j, drop = FALSE]

## S3 method for class 'PolyGeniusAssociations'
merge(..., .id = NULL)

## S3 method for class 'PolyGeniusAssociations'
c(..., recursive = FALSE)

## S3 method for class 'PolyGeniusAssociations'
split(x, f, drop = FALSE, ...)

## S3 method for class 'PolyGeniusAssociations'
filter(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
slice(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
arrange(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
mutate(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
select(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
rename(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
transmute(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
distinct(.data, ..., .keep_all = FALSE)

## S3 method for class 'PolyGeniusAssociations'
group_by(
  .data,
  ...,
  .add = FALSE,
  .drop = dplyr::group_by_drop_default(associationDplyrData(.data))
)

## S3 method for class 'PolyGeniusAssociations'
ungroup(.data, ...)

## S3 method for class 'PolyGeniusAssociations'
summarise(.data, ...)

Arguments

`results`	A `data.frame` or `data.table` containing inferential rows.
`artifacts`	Optional named list of plot-ready artifact tables.
`schemas`	Optional named list of schema definitions, or character schema names resolved by the internal schema registry.
`diagnostics`	Optional diagnostics table or named list of diagnostics tables.
`metadata`	Optional named list of provenance metadata.
`models`	Optional named list of fitted models or model payloads.
`…`	Ignored by the constructor.

Details

⁠$results⁠ contains inferential rows: coefficients, omnibus tests, and other statistical claims. ⁠$artifacts⁠ contains plot-ready derived tables such as prediction grids, survival curves, risk tables, and effect decompositions. ⁠$schemas⁠ describes how result rows and artifacts should be interpreted. ⁠$diagnostics⁠ records fitting warnings, errors, exclusions, and convergence notes. ⁠$metadata⁠ stores provenance. ⁠$models⁠ is intentionally optional and is empty in normal shareable summary output unless a workflow explicitly requests fitted models.

PolyGenius keeps the public facade small. Model-family services produce complete, single-schema PolyGeniusAssociations objects. Higher-level workflows combine those objects with merge.PolyGeniusAssociations(). Plot functions inspect schemas and artifacts to choose the appropriate rendering path.

Value

A list with class c(“PolyGeniusAssociations”, “list”).

For summarise(), a dplyr summary table rather than a PolyGeniusAssociations object.

dplyr verbs

filter(), slice(), arrange(), mutate(), select(), rename(), transmute(), distinct(), group_by(), and ungroup() operate on the ⁠$results⁠ table and return a PolyGeniusAssociations object. Row-filtering verbs also prune ⁠$artifacts⁠, ⁠$diagnostics⁠, and ⁠$models⁠ to the surviving result identifiers. summarise() and distinct() reductions that do not keep association rows return a plain dplyr table because those rows no longer follow an association-result schema.