Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate named kwarg in 3.x branch #507

Merged
merged 3 commits into from
Apr 12, 2021
Merged

Deprecate named kwarg in 3.x branch #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a740cf
remove (unused) `named` kwarg from ranef (#469)
palday Feb 17, 2021
3ed0719
deprecate unused `named` kwarg
palday Apr 12, 2021
88e2e3e
news + patch bump
palday Apr 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
MixedModels v3.5.2 Release Notes
========================
* Explicitly deprecate non-functional `named` kwarg in `ranef` in favor of `raneftables` [#507].

MixedModels v3.5.1 Release Notes
========================
* Fix MIME show methods for models with random-effects not corresponding to a fixed effect [#501].
Expand Down
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "MixedModels"
uuid = "ff71e718-51f3-5ec2-a782-8ffcbfa3c316"
author = ["Phillip Alday <[email protected]>", "Douglas Bates <[email protected]>", "Jose Bayoan Santiago Calderon <[email protected]>"]
version = "3.5.1"
version = "3.5.2"

[deps]
Arrow = "69666777-d1a9-59fb-9406-91d4454c9d45"
Expand Down
9 changes: 7 additions & 2 deletions src/linearmixedmodel.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,14 +689,19 @@ end
ranef!(v::Vector, m::LinearMixedModel, uscale::Bool) = ranef!(v, m, fixef(m), uscale)

"""
ranef(m::LinearMixedModel; uscale=false, named=false)
ranef(m::MixedModel; uscale=false)

Return, as a `Vector{Matrix{T}}`, the conditional modes of the random effects in model `m`.

If `uscale` is `true` the random effects are on the spherical (i.e. `u`) scale, otherwise on
the original scale.

For a named variant, see [`@raneftables`](@ref).
"""
function ranef(m::LinearMixedModel{T}; uscale = false, named = false) where {T}
function ranef(m::LinearMixedModel{T}; uscale = false, named=nothing) where {T}
if named !== nothing
Base.depwarn("the `named` keyword argument is deprecated; it has no effect. Use `raneftables` instead.", :ranef)
end
reterms = m.reterms
v = [Matrix{T}(undef, size(t.z, 1), nlevs(t)) for t in reterms]
ranef!(v, m, uscale)
Expand Down