Skip to contents

Constructor for the cacheable stats containers returned by df_vpcstats(), df_doseprop(), and df_forest(). Each container is a named list with three slots — stats (the per-row summary frame), obs (the observation overlay used by plot builders, may be NULL), and config (named list of run configuration consumed by the plot builders). The class vector is c(<subclass>, "pmx_stats"). The container is checked with validate_pmx_stats() at construction time, including the subclass contract for vpc_stats, doseprop_stats and forest_stats.

Usage

pmx_stats(stats, obs = NULL, config = list(), subclass)

Arguments

stats

A data.frame of per-row summary statistics.

obs

A data.frame of observation rows for the scatter overlay, or NULL when no overlay is used.

config

A named list of run configuration (e.g. column names, CI width, replicate count).

subclass

Character scalar naming the concrete subclass (e.g. "vpc_stats", "doseprop_stats", "forest_stats").

Value

An object of class c(subclass, "pmx_stats").

See also