Skip to content

Commit

Permalink
docs upd
Browse files Browse the repository at this point in the history
  • Loading branch information
PharmCat committed Oct 18, 2023
1 parent ba384cd commit 40ac7ee
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
31 changes: 31 additions & 0 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,11 @@ Metida.Unstructured
Metida.caic
```

### Metida.coefn
```@docs
Metida.coefn
```

### Metida.dof_satter
```@docs
Metida.dof_satter
Expand Down Expand Up @@ -161,6 +166,11 @@ Metida.rand!
Metida.raneff
```

### Metida.raneffn
```@docs
Metida.raneffn
```

### Metida.rankx
```@docs
Metida.rankx
Expand Down Expand Up @@ -248,6 +258,11 @@ Metida.fit
Metida.fit!
```

### islinear
```@docs
Metida.islinear
```

### isfitted
```@docs
Metida.isfitted
Expand Down Expand Up @@ -315,6 +330,12 @@ Metida.dof_contain
Metida.typeiii
```

### Metida.MILMM
```@docs
Metida.MILMM
```


## Not API functions


Expand Down Expand Up @@ -342,3 +363,13 @@ Metida.mulθ₃
```@docs
Metida.mulαtβinc!
```

### Metida.tname
```@docs
Metida.tname
```

### Metida.raneflenv
```@docs
Metida.raneflenv
```
2 changes: 1 addition & 1 deletion docs/src/instanduse.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ nothing # hide

Make model with `@formula` macro from `StatsModels`.
Define `random` and `repreated` effects with [`Metida.VarEffect`](@ref) using [`Metida.@covstr`](@ref) macros. Left side of `@covstr` is model of effect and
right side is a effect itself. [`Metida.HeterogeneousCompoundSymmetry`](@ref) and [`Metida.Diagonal`](@ref) in example bellow is a model of variance-covariance structure. See also [`Metida.@lmmformula`](@ref) macro.
right side is a effect itself. [`Metida.HeterogeneousCompoundSymmetry`](@ref) and [`Metida.Diag`](@ref) (Diagonal) in example bellow is a model of variance-covariance structure. See also [`Metida.@lmmformula`](@ref) macro.

!!! note
In some cases levels of repeated effect should not be equal inside each level of subject or model will not have any sense. For example, it is assumed that usually CSH or UN (Unstructured) using with levels of repeated effect is different inside each level of subject.
Expand Down

0 comments on commit 40ac7ee

Please sign in to comment.