Improve printing of RecordedCatLoop

Frankie Robertson · Frankie Robertson · commit 22823d9aa240 · 2025-09-04T08:20:21.000+03:00
* Use power_summary(...) as main method for all printing
  * Add StdDevEstimator as a std dev measure
  * Add way to make recording entry before any items are administered
  * Add all kinds printing for Recorder and Recording
  * Format numbers to 3dp in Recording
diff --git a/Project.toml b/Project.toml
@@ -7,6 +7,7 @@ version = "0.4.0"
 Accessors = "7d9f7c33-5ae7-4f3b-8dc6-eff91059b697"
 AutoHashEquals = "15f4f7f2-30c1-5605-9d31-71845cf9641f"
 ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
+DataAPI = "9a962f9c-6df0-11e9-0e5d-c546b8b5ee8a"
 DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
@@ -23,8 +24,11 @@ LogarithmicNumbers = "aa2f6b4e-9042-5d33-9679-40d3a6b85899"
 MacroTools = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
 Mmap = "a63ad114-7e13-5084-954f-fe012c677804"
 PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
+PrettyPrinting = "54e16d92-306c-5ea0-a30b-337be88ac337"
+PrettyTables = "08abe8d2-0d0c-5749-adfa-8a2ac140af0d"
 PsychometricsBazaarBase = "b0d9cada-d963-45e9-a4c6-4746243987f1"
 QuickHeaps = "30b38841-0f52-47f8-a5f8-18d5d4064379"
+RDataGet = "a115732e-4334-4ecb-8ea3-f683e7f66d4d"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Reexport = "189a3867-3050-52da-a836-e630ba90ab69"
 Setfield = "efcf1570-3423-57d1-acb7-fd33fddbac46"
@@ -44,6 +48,7 @@ Accessors = "^0.1.12"
 Aqua = "0.8"
 AutoHashEquals = "2"
 ConstructionBase = "^1.2"
+DataAPI = "1.16.0"
 DataFrames = "1.6.1"
 Distributions = "^0.25.88"
 DocStringExtensions = " ^0.9"
@@ -62,8 +67,11 @@ MacroTools = "^0.5.6"
 Mmap = "^1.11"
 Optim = "1.7.3"
 PrecompileTools = "1.2.1"
+PrettyPrinting = "0.4.2"
+PrettyTables = "3"
 PsychometricsBazaarBase = "^0.8.6"
 QuickHeaps = "0.2.2"
+RDataGet = "0.1.0"
 Random = "^1.11"
 Reexport = "1"
 Setfield = "^1"
diff --git a/src/Aggregators/Aggregators.jl b/src/Aggregators/Aggregators.jl
@@ -20,7 +20,7 @@ using FittedItemBanks: AbstractItemBank, ContinuousDomain,
 using ..Responses
 using ..Responses: concrete_response_type, function_xs, function_ys, Responses
 using ..ConfigBase
-using PsychometricsBazaarBase: power_summary
+import PsychometricsBazaarBase: power_summary
 using PsychometricsBazaarBase.ConfigTools: @requiresome, @returnsome,
                                            find1_instance, find1_type,
                                            find1_type_sloppy
@@ -216,8 +216,8 @@ function (integrator::FunctionIntegrator{IntegratorT})(f::F,
     integrator.integrator(FunctionProduct(f, lh_function), ncomp)
 end
 
-function show(io::IO, ::MIME"text/plain", responses::FunctionIntegrator)
-    show(io, MIME("text/plain"), responses.integrator)
+function power_summary(io::IO, responses::FunctionIntegrator)
+    power_summary(io, responses.integrator)
 end
 
 # Defaults
diff --git a/src/Aggregators/ability_estimator.jl b/src/Aggregators/ability_estimator.jl
@@ -26,7 +26,7 @@ function pdf(::LikelihoodAbilityEstimator,
     AbilityLikelihood(tracked_responses)
 end
 
-function show(io::IO, ::MIME"text/plain", ability_estimator::LikelihoodAbilityEstimator)
+function power_summary(io::IO, ability_estimator::LikelihoodAbilityEstimator)
     println(io, "Ability likelihood distribution")
 end
 
@@ -61,7 +61,7 @@ function multiple_response_types_guard(tracked_responses)
     return false
 end
 
-function show(io::IO, ::MIME"text/plain", ability_estimator::PosteriorAbilityEstimator)
+function power_summary(io::IO, ability_estimator::PosteriorAbilityEstimator)
     println(io, "Ability posterior distribution")
     indent_io = indent(io, 2)
     print(indent_io, "Prior: ")
@@ -224,11 +224,11 @@ function ModeAbilityEstimator(bits...)
     ModeAbilityEstimator(dist_est, optimizer)
 end
 
-function show(io::IO, ::MIME"text/plain", ability_estimator::ModeAbilityEstimator)
+function power_summary(io::IO, ability_estimator::ModeAbilityEstimator)
     println(io, "Estimate ability using its mode")
     indent_io = indent(io, 2)
-    show(indent_io, MIME("text/plain"), ability_estimator.dist_est)
-    show(indent_io, MIME("text/plain"), ability_estimator.optim)
+    power_summary(indent_io, ability_estimator.dist_est)
+    power_summary(indent_io, ability_estimator.optim)
 end
 
 struct MeanAbilityEstimator{
@@ -246,12 +246,12 @@ function MeanAbilityEstimator(bits...)
     MeanAbilityEstimator(dist_est, integrator)
 end
 
-function show(io::IO, ::MIME"text/plain", ability_estimator::MeanAbilityEstimator)
+function power_summary(io::IO, ability_estimator::MeanAbilityEstimator)
     println(io, "Estimate ability using its mean")
     indent_io = indent(io, 2)
-    show(indent_io, MIME("text/plain"), ability_estimator.dist_est)
+    power_summary(indent_io, ability_estimator.dist_est)
     print(indent_io, "Integrator: ")
-    show(indent_io, MIME("text/plain"), ability_estimator.integrator)
+    power_summary(indent_io, ability_estimator.integrator)
 end
 
 function distribution_estimator(dist_est::DistributionAbilityEstimator)::DistributionAbilityEstimator
diff --git a/src/Aggregators/optimizers.jl b/src/Aggregators/optimizers.jl
@@ -10,7 +10,7 @@ function (optim::FunctionOptimizer)(f::F,
     optim.optim(comp_f)
 end
 
-function show(io::IO, ::MIME"text/plain", optim::FunctionOptimizer)
+function power_summary(io::IO, optim::FunctionOptimizer)
     indent_io = indent(io, 2)
     if optim.optim isa Optimizers.OneDimOptimOptimizer || optim.optim isa Optimizers.MultiDimOptimOptimizer || optim.optim isa Optimizers.NativeOneDimOptimOptimizer
         inner = optim.optim
diff --git a/src/ConfigBase.jl b/src/ConfigBase.jl
@@ -10,6 +10,8 @@ $(TYPEDEF)
 """
 abstract type CatConfigBase end
 
+show(io::IO, ::MIME"text/plain", obj::CatConfigBase) = power_summary(io, obj)
+
 function walk(f, x::CatConfigBase, lens = identity)
     f(x, lens)
     for fieldname in fieldnames(typeof(x))
diff --git a/src/NextItemRules/NextItemRules.jl b/src/NextItemRules/NextItemRules.jl
@@ -17,6 +17,7 @@ using Random: AbstractRNG, Xoshiro
 
 using ..Responses: BareResponses
 using ..ConfigBase
+import PsychometricsBazaarBase: power_summary
 using PsychometricsBazaarBase.ConfigTools: @requiresome, @returnsome,
                                            find1_instance, find1_type
 using PsychometricsBazaarBase.Integrators: Integrator, intval
diff --git a/src/NextItemRules/combinators/expectation.jl b/src/NextItemRules/combinators/expectation.jl
@@ -39,10 +39,10 @@ function Aggregators.response_expectation(
         item_idx)
 end
 
-function show(io::IO, ::MIME"text/plain", point_response_expectation::PointResponseExpectation)
+function power_summary(io::IO, point_response_expectation::PointResponseExpectation)
     println(io, "Expected response at point ability estimate")
     indent_io = indent(io, 2)
-    show(indent_io, MIME("text/plain"), point_response_expectation.ability_estimator)
+    power_summary(indent_io, point_response_expectation.ability_estimator)
 end
 
 struct DistributionResponseExpectation{
@@ -131,9 +131,9 @@ function compute_criterion(
     res
 end
 
-function show(io::IO, ::MIME"text/plain", item_criterion::ExpectationBasedItemCriterion)
+function power_summary(io::IO, item_criterion::ExpectationBasedItemCriterion)
     println(io, "Optimize an state/item/item-category criterion based on an expected response")
     indent_io = indent(io, 2)
-    show(indent_io, MIME"text/plain"(), item_criterion.response_expectation)
-    show(indent_io, MIME"text/plain"(), item_criterion.criterion)
+    power_summary(indent_io, item_criterion.response_expectation)
+    power_summary(indent_io, item_criterion.criterion)
 end
diff --git a/src/NextItemRules/criteria/pointwise/information.jl b/src/NextItemRules/criteria/pointwise/information.jl
@@ -22,7 +22,7 @@ function compute_criterion_vec(
     -actual
 end
 
-function show(io::IO, ::MIME"text/plain", ::ObservedInformationPointwiseItemCategoryCriterion)
+function power_summary(io::IO, ::ObservedInformationPointwiseItemCategoryCriterion)
     println(io, "Observed pointwise item-category information")
 end
 
@@ -51,7 +51,7 @@ function compute_criterion_vec(
 end
 
 
-function show(io::IO, ::MIME"text/plain", ::RawEmpiricalInformationPointwiseItemCategoryCriterion)
+function power_summary(io::IO, ::RawEmpiricalInformationPointwiseItemCategoryCriterion)
     println(io, "Raw empirical pointwise item-category information")
 end
 
@@ -104,7 +104,7 @@ function compute_criterion_vec(
     -actual
 end
 
-function show(io::IO, ::MIME"text/plain", ::EmpiricalInformationPointwiseItemCategoryCriterion)
+function power_summary(io::IO, ::EmpiricalInformationPointwiseItemCategoryCriterion)
     println(io, "Empirical pointwise item-category information")
 end
 
@@ -131,7 +131,7 @@ function compute_criterion(
     sum(compute_criterion_vec(tii.pcic, ir, ability))
 end
 
-function show(io::IO, ::MIME"text/plain", rule::TotalItemInformation)
+function power_summary(io::IO, rule::TotalItemInformation)
     if rule.pcic isa ObservedInformationPointwiseItemCategoryCriterion
         println(io, "Observed pointwise item information")
     elseif rule.pcic isa RawEmpiricalInformationPointwiseItemCategoryCriterion
@@ -140,6 +140,6 @@ function show(io::IO, ::MIME"text/plain", rule::TotalItemInformation)
         println(io, "Empirical pointwise item information")
     else
         print(io, "Total ")
-        show(io, MIME("text/plain"), rule.pcic)
+        power_summary(io, rule.pcic)
     end
-end
+end
diff --git a/src/NextItemRules/criteria/state/ability_variance.jl b/src/NextItemRules/criteria/state/ability_variance.jl
@@ -68,11 +68,13 @@ function compute_criterion(
         denom)
 end
 
-function show(io::IO, ::MIME"text/plain", criterion::AbilityVariance)
-    println(io, "Minimise variance of ability estimate")
+function power_summary(io::IO, criterion::AbilityVariance; skip_first_line=false)
+    if !skip_first_line
+        println(io, "Minimise variance of ability estimate")
+    end
     indent_io = indent(io, 2)
-    show(indent_io, MIME("text/plain"), criterion.dist_est)
-    show(indent_io, MIME("text/plain"), criterion.integrator)
+    power_summary(indent_io, criterion.dist_est)
+    power_summary(indent_io, criterion.integrator)
 end
 
 struct AbilityCovarianceStateMultiCriterion{
diff --git a/src/NextItemRules/prelude/next_item_rule.jl b/src/NextItemRules/prelude/next_item_rule.jl
@@ -53,11 +53,11 @@ function best_item(rule::NextItemRule, tracked_responses::TrackedResponses)
     best_item(rule, tracked_responses, tracked_responses.item_bank)
 end
 
-function Base.show(io::IO, ::MIME"text/plain", rule::ItemCriterionRule)
+function power_summary(io::IO, rule::ItemCriterionRule)
     println(io, "Pick optimal item criterion according to strategy")
     indent_io = indent(io, 2)
-    show(indent_io, MIME"text/plain"(), rule.strategy)
-    show(indent_io, MIME"text/plain"(), rule.criterion)
+    power_summary(indent_io, rule.strategy)
+    power_summary(indent_io, rule.criterion)
 end
 
 # Default implementation
diff --git a/src/NextItemRules/strategies/balance.jl b/src/NextItemRules/strategies/balance.jl
@@ -39,11 +39,11 @@ function GreedyForcedContentBalancer(targets::AbstractVector, groups, bits...)
     GreedyForcedContentBalancer(targets, groups, NextItemRule(bits...))
 end
 
-function show(io::IO, ::MIME"text/plain", rule::GreedyForcedContentBalancer)
+function power_summary(io::IO, rule::GreedyForcedContentBalancer)
     indent_io = indent(io, 2)
     println(io, "Greedy + forced content balancing")
     println(indent_io, "Target ratio: " * join(rule.targets, ", "))
-    show(indent_io, MIME("text/plain"), rule.inner_rule)
+    power_summary(indent_io, rule.inner_rule)
 end
 
 function next_item_bank(targets, groups, responses, items)
@@ -86,4 +86,4 @@ function compute_criteria(
     expanded = fill(Inf, length(items))
     expanded[matching_indicator] .= criteria
     return expanded
-end
+end
diff --git a/src/NextItemRules/strategies/pointwise.jl b/src/NextItemRules/strategies/pointwise.jl
@@ -16,12 +16,12 @@ function best_item(rule::PointwiseNextItemRule, responses::TrackedResponses, ite
     return idx
 end
 
-function show(io::IO, ::MIME"text/plain", rule::PointwiseNextItemRule)
+function power_summary(io::IO, rule::PointwiseNextItemRule)
     println(io, "Optimize a pointwise criterion at specified points")
     indent_io = indent(io, 2)
     points_desc = join(rule.points, ", ")
     println(indent_io, "Points: $points_desc")
-    show(indent_io, MIME("text/plain"), rule.criterion)
+    power_summary(indent_io, rule.criterion)
 end
 
 
diff --git a/src/NextItemRules/strategies/randomesque.jl b/src/NextItemRules/strategies/randomesque.jl
@@ -53,6 +53,6 @@ function best_item(
     randomesque(rule.strategy.rng, rule.criterion, responses, items, rule.strategy.k)[1]
 end
 
-function show(io::IO, ::MIME"text/plain", rule::RandomesqueStrategy)
+function power_summary(io::IO, rule::RandomesqueStrategy)
     println(io, "Randomesque strategy with k = $(rule.k)")
-end
+end
diff --git a/src/NextItemRules/strategies/sequential.jl b/src/NextItemRules/strategies/sequential.jl
@@ -29,14 +29,14 @@ function compute_criteria(rule::FixedRuleSequencer, responses::TrackedResponses)
     return compute_criteria(current_rule(rule, responses), responses)
 end
 
-function show(io::IO, ::MIME"text/plain", rule::FixedRuleSequencer)
+function power_summary(io::IO, rule::FixedRuleSequencer)
     indent_io = indent(io, 2)
     println(io, "Fixed rule sequencing:")
     print(indent_io, "Firstly: ")
-    show(indent_io, MIME("text/plain"), rule.rules[1])
+    power_summary(indent_io, rule.rules[1])
     for (responses, rule) in zip(rule.breaks, rule.rules[2:end])
         print(indent_io, "After $responses responses: ")
-        show(indent_io, MIME("text/plain"), rule)
+        power_summary(indent_io, rule)
     end
 end
 
@@ -58,11 +58,11 @@ function best_item(rule::MemoryNextItemRule, responses::TrackedResponses, _items
     # TODO: Add some basic error checking -- can only panic
 end
 
-function show(io::IO, ::MIME"text/plain", rule::MemoryNextItemRule)
+function power_summary(io::IO, rule::MemoryNextItemRule)
     item_list = join(rule.item_idxs, ", ")
     println(io, "Present the items indexed: $item_list")
 end
 
 function FixedFirstItem(item_idx::Int, rule::NextItemRule)
     FixedRuleSequencer((1,), (MemoryNextItemRule((item_idx,)), rule))
-end
+end
diff --git a/src/Responses.jl b/src/Responses.jl
@@ -75,6 +75,10 @@ function Base.empty!(responses::BareResponses)
     Base.empty!(responses.values)
 end
 
+function Base.length(responses::BareResponses)
+    return length(responses.indices)
+end
+
 function add_response!(responses::BareResponses, response::Response)::BareResponses
     push!(responses.indices, response.index)
     push!(responses.values, response.value)
diff --git a/src/Rules.jl b/src/Rules.jl
@@ -89,17 +89,17 @@ end
 function power_summary(io::IO, rules::CatRules; toplevel=false)
     # TODO
     print(io, "Next item rule: ")
-    show(io, MIME("text/plain"), rules.next_item)
+    power_summary(io, rules.next_item)
     if toplevel
         println(io)
     end
     print(io, "Termination condition: ")
-    show(io, MIME("text/plain"), rules.termination_condition)
+    power_summary(io, rules.termination_condition)
     if toplevel
         println(io)
     end
     print(io, "Ability estimator: ")
-    show(io, MIME("text/plain"), rules.ability_estimator)
+    power_summary(io, rules.ability_estimator)
 end
 
 function _find_ability_estimator_and_tracker(bits...)
diff --git a/src/Sim/Sim.jl b/src/Sim/Sim.jl
@@ -9,6 +9,7 @@ using FittedItemBanks: AbstractItemBank, ResponseType, ItemResponse, domdims
 using PsychometricsBazaarBase: show_into_buf, power_summary_into_buf
 using PsychometricsBazaarBase.Integrators
 using PsychometricsBazaarBase.IndentWrappers: indent
+using PsychometricsBazaarBase: GridSummary
 using ..ConfigBase
 using ..Responses
 using ..Rules: CatRules
@@ -24,9 +25,13 @@ using ..Aggregators: TrackedResponses,
                      MeanAbilityEstimator,
                      LikelihoodAbilityEstimator,
                      RiemannEnumerationIntegrator
-using ..NextItemRules: AbilityVariance, compute_criteria, best_item
+using ..NextItemRules: AbilityVariance, compute_criteria, compute_criterion, best_item
 import Base: show
 import PsychometricsBazaarBase: power_summary
+using PrettyPrinting
+using PrettyTables: fmt__printf
+using DataAPI: nrow
+using DataFrames: DataFrames
 
 export CatRecorder, CatRecording
 export CatLoop, record!
@@ -38,4 +43,6 @@ include("./loop.jl")
 include("./run.jl")
 include("./recorded_loop.jl")
 
+show(io::IO, ::MIME"text/plain", obj::Union{CatRecorder, CatRecording, RecordedCatLoop}) = power_summary(io, obj)
+
 end
diff --git a/src/Sim/loop.jl b/src/Sim/loop.jl
@@ -27,14 +27,14 @@ struct CatLoop{CatEngineT} <: CatConfigBase
     new_response_callback::Any
     """
     A callback called each time a CAT is run
-    If provided, it is passed `(item_bank::AbstractItemBank)`.
+    If provided, it is passed `(loop::CatLoop, responses::TrackedResponses)`.
     """
     init_callback::Any
 end
 
-function show(io::IO, ::MIME"text/plain", rules::CatLoop)
+function power_summary(io::IO, rules::CatLoop)
     print(io, "Computer-Adaptive Test Loop based on ")
-    show(io, MIME("text/plain"), rules.rules)
+    power_summary(io, rules.rules)
 end
 
 function collate_cat_callbacks(callbacks...)
diff --git a/src/Sim/recorded_loop.jl b/src/Sim/recorded_loop.jl
diff --git a/src/Sim/recorder.jl b/src/Sim/recorder.jl
diff --git a/src/Sim/run.jl b/src/Sim/run.jl
diff --git a/src/TerminationConditions.jl b/src/TerminationConditions.jl
