Skip to content

Commit

Permalink
Doc improvements (#76)
Browse files Browse the repository at this point in the history 
* note about sigmas being relative

* version bump

* add note to update!

* docs compat
  • Loading branch information
@palday
palday authored Sep 12, 2024
1 parent 0aceb4d commit 2685b7f
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Project.toml
View file
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
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
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

2 comments on commit 2685b7f

@palday
Copy link
Member Author

@palday palday commented on 2685b7f Sep 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/115058

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.2.11 -m "<description of version>" 2685b7fd48cfcb97139591ff5771cc33d7beba1f
git push origin v0.2.11

Please sign in to comment.