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

Jump to bottom

Doc improvements #76

Merged
merged 4 commits into from
Sep 12, 2024
Merged

Doc improvements #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
76ec8ce
note about sigmas being relative
palday Sep 12, 2024
dca2723
version bump
palday Sep 12, 2024
2def198
add note to update!
palday Sep 12, 2024
d636918
docs compat
palday Sep 12, 2024
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
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 = "MixedModelsSim"
uuid = "d5ae56c5-23ca-4a1f-b505-9fc4796fc1fe"
authors = ["Phillip Alday", "Douglas Bates", "Lisa DeBruine", "Reinhold Kliegl"]
version = "0.2.10"
version = "0.2.11"

[deps]
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
Expand Down
8 changes: 3 additions & 5 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
[deps]
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
CategoricalArrays = "324d7699-5711-5eae-9e2f-1d82baa6b597"
DataFrameMacros = "75880514-38bc-4a95-a458-c2aea5a3a702"
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
Expand All @@ -16,9 +15,8 @@ Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"

[compat]
CairoMakie = "0.10"
CategoricalArrays = "0.10"
DataFrames = "1"
CairoMakie = "0.12"
DataFrameMacros = "0.1"
Documenter = "1"
DataFrames = "1"
Documenter = "1.3"
StableRNGs = "1"
10 changes: 10 additions & 0 deletions src/utilities.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,11 @@ Update the mixed model to use the random-effects covariance matrices.
The `namedre` can be created using [`create_re`](@ref). The `namedre` are specified
by the name of the blocking variable, e.g. `subj=create_re(...)`.
!!! warning
The model's response must be initialized to a non-constant value before
calling this function, otherwise the model update will fail with a
`PosDefException`.
!!! warning
Setting θ directly as a keyword-argument is deprecated.
Expand Down Expand Up @@ -273,6 +278,11 @@ Create the covariance factor for a random effect from the standard deviations an
The `sigmas` should be specified in the same order as the random slopes in the
output of `VarCorr(m)`.
!!! note
The `sigmas` are specified **relative** to the residual standard deviation.
Absolute values must be scaled by dividing by the assumed residual
standard deviation.
The correlation matrix defaults to the identity matrix, i.e. no correlation between
random effects.
Expand Down
Loading