Skip to content

Commit 639abf4

Browse files
authored
(re)moved MixedModelsExt traces (#243)
* (re)moved MixedModelsExt traces * fix julia1.10 bug, it was non-stable rng unittest * remove lmm docs in make.jl * feel free to include this test, once UnfoldSim.jl is through review... * fix ref error
1 parent 015b6fa commit 639abf4

33 files changed

+48
-2068
lines changed

.github/workflows/Docs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ jobs:
5757
GKSwstype: "100" # https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988
5858

5959
- name: Update UnfoldDocs
60+
if: github.ref == 'refs/heads/main'
6061
uses: peter-evans/repository-dispatch@v3
6162
with:
6263
token: ${{ secrets.UNFOLDDOCSPAT }}

Project.toml

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "Unfold"
22
uuid = "181c99d8-e21b-4ff3-b70b-c233eddec679"
33
authors = ["Benedikt Ehinger <[email protected]>"]
4-
version = "0.7.9"
4+
version = "0.8.0-dev"
55

66
[deps]
77
BSplineKit = "093aae92-e908-43d7-9660-e50ee39d5a0a"
@@ -22,7 +22,6 @@ LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
2222
Logging = "56ddb016-857b-54e1-b83d-db4d58db5568"
2323
MLBase = "f0e99cf1-93fa-52ec-9ecc-5026115318e0"
2424
Missings = "e1d29d7a-bbdc-5cf2-9ac0-f12de2c33e28"
25-
MixedModels = "ff71e718-51f3-5ec2-a782-8ffcbfa3c316"
2625
OrderedCollections = "bac558e1-5e72-5ebc-8fee-abe8a469f55d"
2726
PooledArrays = "2dfb63ee-cc39-5dd5-95bd-886bf059d720"
2827
ProgressMeter = "92933f4c-e287-5a05-a399-4b506db050ca"
@@ -44,14 +43,12 @@ TypedTables = "9d95f2ec-7b3d-5a63-8d20-e2491e220bb9"
4443
BSplineKit = "093aae92-e908-43d7-9660-e50ee39d5a0a"
4544
CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba"
4645
Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
47-
MixedModels = "ff71e718-51f3-5ec2-a782-8ffcbfa3c316"
4846
RobustModels = "d6ea1423-9682-4bbd-952f-b1577cbf8c98"
4947

5048
[extensions]
5149
UnfoldBSplineKitExt = "BSplineKit"
5250
UnfoldCUDAExt = "CUDA"
5351
UnfoldKrylovExt = ["Krylov", "CUDA"]
54-
UnfoldMixedModelsExt = "MixedModels"
5552
UnfoldRobustModelsExt = "RobustModels"
5653

5754
[compat]
@@ -73,7 +70,6 @@ LinearAlgebra = "1"
7370
Logging = "1"
7471
MLBase = "0.9"
7572
Missings = "1"
76-
MixedModels = "4"
7773
OrderedCollections = "1"
7874
PooledArrays = "1"
7975
ProgressMeter = "1"

docs/make.jl

-3
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ makedocs(
2727
"Tutorials" => [
2828
"rERP (mass univariate)" => "tutorials/lm_mu.md",
2929
"rERP (overlap correction)" => "tutorials/lm_overlap.md",
30-
"lmmERP (mass univariate)" => "tutorials/lmm_mu.md",
31-
"lmmERP (overlap correction)" => "tutorials/lmm_overlap.md",
3230
],
3331
"HowTo" => [
3432
"Multiple events" => "HowTo/multiple_events.md",
@@ -37,7 +35,6 @@ makedocs(
3735
"Marginal effects (must read re: splines)" => "generated/HowTo/effects.md",
3836
"Alternative Solvers (Robust, GPU, B2B)" => "HowTo/custom_solvers.md",
3937
#"Time domain basis functions"=>"generated/HowTo/timesplines.md",
40-
"P-values for mixedModels" => "HowTo/lmm_pvalues.md",
4138
"Save and load Unfold models" => "generated/HowTo/unfold_io.md",
4239
"Duration-scaled basisfunctions (Hassall-style)" => "generated/HowTo/FIRduration.md",
4340
"🐍 Import EEG with PyMNE.jl" => "HowTo/pymne.md",

docs/src/HowTo/lmm_pvalues.md

-102
This file was deleted.

docs/src/index.md

+26-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Unfold Documentation
22

3-
If you want to follow the **tutorials**, best to start with the [mass-univariate approach](@ref lm_massunivariate), which should be familiar to you if you did ERPs before. Then the [overlap-correction tutorial](@ref lm_overlap), [mixed mass univariate](@ref lmm_massunivariate), [mixed overlap (tricky!)](@ref lmm_overlap). If you are then not satisfied, check out more advanced topics: [effects-interface (aka what to do after fitting)](@ref effects), or non-linear effects.
3+
If you want to follow the **tutorials**, best to start with the [mass-univariate approach](@ref lm_massunivariate), which should be familiar to you if you did ERPs before. Then the [overlap-correction tutorial](@ref lm_overlap). If you are then not satisfied, check out more advanced topics: [effects-interface (aka what to do after fitting)](@ref effects), or non-linear effects.
44

55
In case you want to understand the tools better, check out our **explanations**.
66

@@ -17,8 +17,32 @@ There are four main model types
1717
1. Timeexpansion **No**, Mixed **Yes** : `fit(UnfoldModel, [Any=>(fLMM, -0.1:0.01:0.5)], evts, data_epoch)`
1818
1. Timeexpansion **Yes**, Mixed **Yes**: `fit(UnfoldModel, [Any=>(fLMM, basisfunction)], evts, data)`
1919

20+
## rERP model
21+
2022
```julia
23+
using Unfold
24+
using UnfoldSim
25+
data, evts = UnfoldSim.predef_eeg()
26+
2127
f = @formula 0 ~ 1 + condition
28+
basisfunction = firbasis= (-0.1,0.5), sfreq = 100)
29+
fit(UnfoldModel, [Any=>(f, basisfunction)], evts, data)
30+
nothing #hide
31+
```
32+
33+
## MixedModels
34+
35+
It is also possible to fit Linear Mixed Models using the sister-package `UnfoldMixedModels.jl`
36+
37+
```julia
38+
using UnfoldMixedModels
39+
using UnfoldSim
40+
data, evts = UnfoldSim.predef_eeg(10;return_epoched=true) # 10 subjects
41+
data = reshape(data,size(data,1),:) # concatenate subjects
42+
43+
times = range(-0.1,0.5,size(data,1)) # arbitrary time-vector
44+
2245
fLMM = @formula 0 ~ 1 + condition + (1|subject) + (1|item)
23-
basisfunction = firbasis= (-0.1,0.5), sfreq = 100))
46+
fit(UnfoldModel, [Any=>(f, times)], evts, data)
47+
nothing #hide
2448
```

docs/src/references/extensions.md

-9
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,6 @@
33
In Julia 1.9 Package Extensions were introduced. Unfold.jl is making use of them in four ways.
44
Prior to using some functionality, you have to add + load specific package(s) for the functionality to be available. The reason for this is, that if you don't need e.g. GPU-support, you also will not need to install it.
55

6-
## MixedModels
7-
8-
To use formulas like `@formula(0~1+condition+(1+condition|subject))` you have to load MixedModels. e.g.
9-
10-
```julia
11-
using MixedModels
12-
using Unfold
13-
```
14-
156
## GPU: Krylov,CUDA
167

178
To use gpu support as described in @Ref(custom_solvers) you have to:

docs/src/tutorials/lmm_mu.md

-83
This file was deleted.

docs/src/tutorials/lmm_overlap.md

-79
This file was deleted.

0 commit comments

Comments
 (0)