Improve show methods

Author: Frankie Robertson

src/Rules.jl

@@ -82,13 +82,14 @@ function CatRules(bits...)
 end
 
 function show(io::IO, ::MIME"text/plain", rules::CatRules)
-    indent_io = indent(io, 2)
-    println(io, "Next item rule:")
-    show(indent_io, MIME"text/plain"(), rules.next_item)
-    println(io, "Termination condition:")
-    show(indent_io, MIME"text/plain"(), rules.termination_condition)
-    println(io, "Ability estimator:")
-    show(indent_io, MIME"text/plain"(), rules.ability_estimator)
+    print(io, "Next item rule: ")
+    show(io, MIME("text/plain"), rules.next_item)
+    println(io)
+    print(io, "Termination condition: ")
+    show(io, MIME("text/plain"), rules.termination_condition)
+    println(io)
+    print(io, "Ability estimator: ")
+    show(io, MIME("text/plain"), rules.ability_estimator)
 end
 
 function _find_ability_estimator_and_tracker(bits...)

src/TerminationConditions.jl

@@ -6,6 +6,7 @@ using ..Aggregators: TrackedResponses
 using ..ConfigBase
 using PsychometricsBazaarBase.ConfigTools: @returnsome, find1_instance
 using FittedItemBanks
+import Base: show
 
 export TerminationCondition,
        LengthTerminationCondition, SimpleFunctionTerminationCondition
@@ -32,6 +33,10 @@ function (condition::LengthTerminationCondition)(responses::TrackedResponses,
     length(responses) >= condition.num_items
 end
 
+function show(io::IO, ::MIME"text/plain", condition::LengthTerminationCondition)
+    println(io, "Terminate test after administering $(condition.num_items) items")
+end
+
 # Alias for old name
 const FixedItemsTerminationCondition = LengthTerminationCondition
 

src/aggregators/Aggregators.jl

@@ -30,8 +30,9 @@ using PsychometricsBazaarBase.Integrators: Integrators,
                                            IntValue, Integrator,
                                            PreallocatedFixedGridIntegrator,
                                            normdenom
-using PsychometricsBazaarBase.Optimizers: OneDimOptimOptimizer, Optimizer
+using PsychometricsBazaarBase.Optimizers: OneDimOptimOptimizer, Optimizer, Optimizers
 using PsychometricsBazaarBase.ConstDistributions: std_normal, std_mv_normal
+using PsychometricsBazaarBase.IndentWrappers: indent
 import Distributions: pdf
 import Base: show
 
@@ -209,6 +210,10 @@ 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)
+end
+
 # Defaults
 const optim_tol = 1e-12
 const int_tol = 1e-8

src/aggregators/ability_estimator.jl

@@ -26,6 +26,10 @@ function pdf(::LikelihoodAbilityEstimator,
     AbilityLikelihood(tracked_responses)
 end
 
+function show(io::IO, ::MIME"text/plain", ability_estimator::LikelihoodAbilityEstimator)
+    println(io, "Ability likelihood distribution")
+end
+
 struct PosteriorAbilityEstimator{PriorT <: Distribution} <: DistributionAbilityEstimator
     prior::PriorT
 end
@@ -57,6 +61,14 @@ function multiple_response_types_guard(tracked_responses)
     return false
 end
 
+function show(io::IO, ::MIME"text/plain", ability_estimator::PosteriorAbilityEstimator)
+    println(io, "Ability posterior distribution")
+    indent_io = indent(io, 2)
+    print(indent_io, "Prior: ")
+    show(indent_io, MIME("text/plain"), ability_estimator.prior)
+    println(io)
+end
+
 struct GuardedAbilityEstimator{T <: DistributionAbilityEstimator, U <: DistributionAbilityEstimator, F} <: DistributionAbilityEstimator
     est::T
     fallback::U
@@ -214,11 +226,9 @@ end
 
 function show(io::IO, ::MIME"text/plain", ability_estimator::ModeAbilityEstimator)
     println(io, "Estimate ability using its mode")
-    indent_io = indent(io, 2; skip_first=true)
-    print(indent_io, "Distribution estimator ")
-    show(indent_io, ability_estimator.dist_est)
-    print(indent_io, "Optimizer: ")
-    show(indent_io, ability_estimator.optim)
+    indent_io = indent(io, 2)
+    show(indent_io, MIME("text/plain"), ability_estimator.dist_est)
+    show(indent_io, MIME("text/plain"), ability_estimator.optim)
 end
 
 struct MeanAbilityEstimator{
@@ -236,6 +246,14 @@ function MeanAbilityEstimator(bits...)
     MeanAbilityEstimator(dist_est, integrator)
 end
 
+function show(io::IO, ::MIME"text/plain", 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)
+    print(indent_io, "Integrator: ")
+    show(indent_io, MIME("text/plain"), ability_estimator.integrator)
+end
+
 function distribution_estimator(dist_est::DistributionAbilityEstimator)::DistributionAbilityEstimator
     dist_est
 end

src/aggregators/optimizers.jl

@@ -12,17 +12,17 @@ end
 
 function show(io::IO, ::MIME"text/plain", optim::FunctionOptimizer)
     indent_io = indent(io, 2)
-    if optim.optim isa OneDimOptimOptimizer || optim.optim isa MultiDimOptimOptimizer || optim.optim isa NativeOneDimOptimOptimizer
+    if optim.optim isa Optimizers.OneDimOptimOptimizer || optim.optim isa Optimizers.MultiDimOptimOptimizer || optim.optim isa Optimizers.NativeOneDimOptimOptimizer
         inner = optim.optim
         println(io, "Optimizer:")
-        if optim.optim isa NativeOneDimOptimOptimizer
+        if optim.optim isa Optimizers.NativeOneDimOptimOptimizer
             name = typeof(inner.method).name.name
         else
             name = typeof(inner.optim).name.name
         end
-        print(indent_io, "Method: ", name)
-        print(indent_io, "Lo: ", inner.lo)
-        print(indent_io, "Hi: ", inner.hi)
+        println(indent_io, "Method: ", name)
+        println(indent_io, "Lo: ", inner.lo)
+        println(indent_io, "Hi: ", inner.hi)
     end
 end
 

src/next_item_rules/combinators/expectation.jl

@@ -42,9 +42,7 @@ end
 function show(io::IO, ::MIME"text/plain", point_response_expectation::PointResponseExpectation)
     println(io, "Expected response at point ability estimate")
     indent_io = indent(io, 2)
-    print(indent_io, "Ability estimator: ")
-    summary(indent_io, point_response_expectation.ability_estimator)
-    println(io)
+    show(indent_io, MIME("text/plain"), point_response_expectation.ability_estimator)
 end
 
 struct DistributionResponseExpectation{
@@ -136,8 +134,6 @@ end
 function show(io::IO, ::MIME"text/plain", item_criterion::ExpectationBasedItemCriterion)
     println(io, "Optimize an state/item/item-category criterion based on an expected response")
     indent_io = indent(io, 2)
-    print(indent_io, "Expected response obtained by: ")
     show(indent_io, MIME"text/plain"(), item_criterion.response_expectation)
-    print(indent_io, "Criterion: ")
     show(indent_io, MIME"text/plain"(), item_criterion.criterion)
-end
+end

src/next_item_rules/criteria/state/ability_variance.jl

@@ -71,10 +71,8 @@ end
 function show(io::IO, ::MIME"text/plain", criterion::AbilityVarianceStateCriterion)
     println(io, "Minimise variance of ability estimate")
     indent_io = indent(io, 2)
-    print(indent_io, "Distribution estimator: ")
-    show(indent_io, MIME"text/plain"(), criterion.dist_est)
-    print(indent_io, "Integrator: ")
-    show(indent_io, MIME"text/plain"(), criterion.integrator)
+    show(indent_io, MIME("text/plain"), criterion.dist_est)
+    show(indent_io, MIME("text/plain"), criterion.integrator)
 end
 
 struct AbilityCovarianceStateMultiCriterion{

src/next_item_rules/prelude/next_item_rule.jl

@@ -56,13 +56,11 @@ end
 function Base.show(io::IO, ::MIME"text/plain", rule::ItemStrategyNextItemRule)
     println(io, "Pick optimal item criterion according to strategy")
     indent_io = indent(io, 2)
-    print(indent_io, "Strategy: ")
     show(indent_io, MIME"text/plain"(), rule.strategy)
-    print(indent_io, "Item criterion: ")
     show(indent_io, MIME"text/plain"(), rule.criterion)
 end
 
 # Default implementation
 function compute_criteria(::NextItemRule, ::TrackedResponses)
     nothing
-end
+end

src/next_item_rules/strategies/pointwise.jl

@@ -21,7 +21,6 @@ function show(io::IO, ::MIME"text/plain", rule::PointwiseNextItemRule)
     indent_io = indent(io, 2)
     points_desc = join(rule.points, ", ")
     println(indent_io, "Points: $points_desc")
-    print(indent_io, "Criterion: ")
     show(indent_io, MIME("text/plain"), rule.criterion)
 end