Inspect an experiment's effective execution plan
Source:R/availability-policy.R
ledgr_experiment_plan.RdReports whether point-in-time availability is active and which fact-family checks are declared, omitted, assumption-backed, or disabled. Inspection is read-only and does not execute the strategy.
Usage
ledgr_experiment_plan(x, ...)
# S3 method for class 'ledgr_experiment_plan'
print(x, ...)Value
A ledgr_experiment_plan object. price_basis is the basis the
experiment executes on: the snapshot's declared basis, "split_adjusted"
as an assumed default for an availability-aware experiment whose snapshot
declares none (price_basis_default is then TRUE), or "undeclared"
for a dense snapshot without one. Its checks tibble reports each
family status and keeps generated-schedule and assumed-knowledge reasons
separate in assumption_reasons. Its assumptions tibble lists the
declared valuation-horizon and terminal-outcome choices, one row per
setting, with value and a default flag that is TRUE when the
value is the constructor default rather than a choice the caller changed.
The held terminal map has one held_terminal_position.<label> row per
entry, in map order. history_policy is the experiment's
ledgr_history_policy(); an availability-aware plan, which alone uses
it, adds history.price_carry, history.output_carry and
history.segment_limit rows. Its print names
valuation.max_sessions as the valuation stale-mark horizon and shows
the history policy beside it, each value marked default or declared.
Articles
Point-in-time universe workflow:
vignette("survivorship-bias", package = "ledgr")
system.file("doc", "survivorship-bias.html", package = "ledgr")