Fix markdown show on 1.13 (#829)

* more stability in ordering

* slightly nicer mime constructor call

* don't define method on Julia 13

* update test

* NEWS + version bump

---------

Co-authored-by: Alex Arslan <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: 3 people

NEWS.md

@@ -1,3 +1,7 @@
+MixedModels v4.35.2 Release Notes
+==============================
+- Update to the `show(::IO, ::MIME, x)` methods for consistent ordering across Julia versions of variance components without associated fixed effects. This may result in change of ordering on existing Julia versions, but ordering will now match the ordering in the default REPL display (and reflect the model internal ordering), [#829]
+
 MixedModels v4.35.1 Release Notes
 ==============================
 - The final parameter vector `optsum.final` is now reset in calls to `unfit!`. This has the secondary effect of correctly starting the fit for `prfit!` at the initial parameter vector instead of the final parameter vector of any previous optimization. [#828]
@@ -637,3 +641,4 @@ Package dependencies
 [#823]: https://github.com/JuliaStats/MixedModels.jl/issues/823
 [#825]: https://github.com/JuliaStats/MixedModels.jl/issues/825
 [#828]: https://github.com/JuliaStats/MixedModels.jl/issues/828
+[#829]: https://github.com/JuliaStats/MixedModels.jl/issues/829

Project.toml

@@ -1,7 +1,7 @@
 name = "MixedModels"
 uuid = "ff71e718-51f3-5ec2-a782-8ffcbfa3c316"
 author = ["Phillip Alday <[email protected]>", "Douglas Bates <[email protected]>"]
-version = "4.35.1"
+version = "4.35.2"
 
 [deps]
 Arrow = "69666777-d1a9-59fb-9406-91d4454c9d45"

src/blockdescription.jl

@@ -55,4 +55,4 @@ function Base.show(io::IO, ::MIME"text/plain", b::BlockDescription)
     end
 end
 
-Base.show(io::IO, b::BlockDescription) = show(io, MIME"text/plain"(), b)
+Base.show(io::IO, b::BlockDescription) = show(io, MIME("text/plain"), b)

src/generalizedlinearmixedmodel.jl

@@ -763,7 +763,7 @@ function Base.show(
     return show(io, coeftable(m))
 end
 
-Base.show(io::IO, m::GeneralizedLinearMixedModel) = show(io, MIME"text/plain"(), m)
+Base.show(io::IO, m::GeneralizedLinearMixedModel) = show(io, MIME("text/plain"), m)
 
 function stderror!(v::AbstractVector{T}, m::GeneralizedLinearMixedModel{T}) where {T}
     # initialize to appropriate NaN for rank-deficient case

src/likelihoodratiotest.jl

@@ -230,7 +230,7 @@ function Base.show(io::IO, ::MIME"text/plain", lrt::LikelihoodRatioTest)
     return nothing
 end
 
-Base.show(io::IO, lrt::LikelihoodRatioTest) = Base.show(io, MIME"text/plain"(), lrt)
+Base.show(io::IO, lrt::LikelihoodRatioTest) = Base.show(io, MIME("text/plain"), lrt)
 
 function _iscomparable(m::LinearMixedModel...)
     isconstant(getproperty.(getproperty.(m, :optsum), :REML)) || throw(

src/linearmixedmodel.jl

@@ -1084,7 +1084,7 @@ function Base.show(io::IO, ::MIME"text/plain", m::LinearMixedModel)
     return show(io, coeftable(m))
 end
 
-Base.show(io::IO, m::LinearMixedModel) = Base.show(io, MIME"text/plain"(), m)
+Base.show(io::IO, m::LinearMixedModel) = Base.show(io, MIME("text/plain"), m)
 
 """
     _coord(A::AbstractMatrix)

src/mimeshow.jl

@@ -148,8 +148,11 @@ function _markdown(m::MixedModel)
         push!(rows, newrow)
     end
 
-    re_without_fe = setdiff(
-        mapfoldl(x -> Set(getproperty(x, :cnames)), ∪, m.reterms), coefnames(m)
+    re_without_fe = setdiff!(
+        # why not use `Set`? because ordering can change between releases, while
+        # unique preserves the original order
+        unique!(mapfoldl(x -> getproperty(x, :cnames), append!, m.reterms; init=String[])),
+        coefnames(m),
     )
 
     for bname in re_without_fe

src/pca.jl

@@ -56,7 +56,7 @@ function Base.propertynames(pca::PCA, private::Bool=false)
     )
 end
 
-Base.show(io::IO, pca::PCA; kwargs...) = Base.show(io, MIME"text/plain"(), pca; kwargs...)
+Base.show(io::IO, pca::PCA; kwargs...) = Base.show(io, MIME("text/plain"), pca; kwargs...)
 
 function Base.show(
     io::IO,

src/randomeffectsterm.jl

@@ -16,7 +16,7 @@ function RandomEffectsTerm(lhs::StatsModels.TermOrTerms, rhs::NTuple{2,AbstractT
     return (RandomEffectsTerm(lhs, rhs[1]), RandomEffectsTerm(lhs, rhs[2]))
 end
 
-Base.show(io::IO, t::RandomEffectsTerm) = Base.show(io, MIME"text/plain"(), t)
+Base.show(io::IO, t::RandomEffectsTerm) = Base.show(io, MIME("text/plain"), t)
 
 function Base.show(io::IO, ::MIME"text/plain", t::RandomEffectsTerm)
     return print(io, "($(t.lhs) | $(t.rhs))")
@@ -243,7 +243,7 @@ StatsModels.degree(t::ZeroCorr) = StatsModels.degree(t.term)
 # cf https://github.com/JuliaStats/StatsModels.jl/blob/41b025409af03c0e019591ac6e817b22efbb4e17/src/terms.jl#L421-L422
 StatsModels.degree(t::FunctionTerm{typeof(zerocorr)}) = StatsModels.degree(only(t.args))
 
-Base.show(io::IO, t::ZeroCorr) = Base.show(io, MIME"text/plain"(), t)
+Base.show(io::IO, t::ZeroCorr) = Base.show(io, MIME("text/plain"), t)
 function Base.show(io::IO, ::MIME"text/plain", t::ZeroCorr)
     # ranefterms already show with parens
     return print(io, "zerocorr", t.term)

src/varcorr.jl

@@ -23,7 +23,7 @@ function aligncompact(v, digits=_printdigits(v))
     return Base.Ryu.writefixed.(v, Ref(digits))
 end
 
-Base.show(io::IO, vc::VarCorr) = Base.show(io, MIME"text/plain"(), vc)
+Base.show(io::IO, vc::VarCorr) = Base.show(io, MIME("text/plain"), vc)
 
 function Base.show(io::IO, ::MIME"text/plain", vc::VarCorr)
     σρ = vc.σρ