fix

PharmCat · Mar 18, 2023 · 4d50073 · 4d50073
1 parent 45f1e6c
commit 4d50073
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/docs/src/examples.md b/docs/src/examples.md
@@ -1,7 +1,7 @@
 ### Example 1 - Continuous and categorical predictors
 
 ```@example lmmexample
-using Metida, CSV, DataFrames, MixedModels, CategoricalArrays;
+using Metida, CSV, DataFrames, CategoricalArrays;
 
 import Pkg
 Pkg.activate("MixedModels")

diff --git a/src/random.jl b/src/random.jl
@@ -12,6 +12,11 @@ function rand!(rng::AbstractRNG, v::AbstractVector, lmm::LMM)
     if !lmm.result.fit error("Model not fitted!") end
     rand!(rng, v, lmm, lmm.result.theta, lmm.result.beta)
 end
+"""
+    rand!(v::AbstractVector, lmm::LMM) = rand!(default_rng(), v, lmm, lmm.result.theta, lmm.result.beta)
+
+Generate random responce vector for fitted 'lmm' model, store results in `v`.
+"""
 rand!(v::AbstractVector, lmm::LMM) = rand!(default_rng(), v, lmm, lmm.result.theta, lmm.result.beta)
 """
     rand(rng::AbstractRNG, lmm::LMM{T}; theta) where T
@@ -22,6 +27,11 @@ function rand(rng::AbstractRNG, lmm::LMM{T}, theta::AbstractVector) where T
     v = Vector{T}(undef, nobs(lmm))
     rand!(rng, v, lmm, theta)
 end
+"""
+    rand!(rng::AbstractRNG, lmm::LMM{T}; theta) where T
+
+Generate random responce vector 'lmm' model, theta covariance vector, and zero means, store results in `v`.
+"""
 function rand!(rng::AbstractRNG, v::AbstractVector, lmm::LMM{T}, theta::AbstractVector) where T
     n = length(lmm.covstr.vcovblock)
     if length(v) != nobs(lmm) error("Wrong v length!") end