Skip to content

Commit bf7b26f

Browse files
committed
new landing page
1 parent 9f0d45c commit bf7b26f

File tree

1 file changed

+51
-5
lines changed

1 file changed

+51
-5
lines changed

docs/src/index.md

+51-5
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
# Unfold Documentation
1+
```@meta
2+
CurrentModule = Unfold
3+
```
4+
5+
# Unfold.jl Documentation
6+
7+
Welcome to [Unfold.jl](https://github.com/unfoldtoolbox/Unfold.jl):
28

39
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.
410

@@ -8,17 +14,36 @@ Once you are familiar with the tools, check out further **how-to guides** for sp
814

915
In case you want to understand the toolbox better, we plan to offer **technical references**. This includes Benchmarks & Explorations.
1016

11-
## Quick start
1217

18+
```@raw html
19+
<div style="width:60%; margin: auto;">
20+
21+
</div>
22+
```
23+
24+
## Key features
25+
- **Modularity:**
26+
- **:**
27+
28+
29+
## Installation
30+
```julia-repl
31+
julia> using Pkg; Pkg.add("Unfold")
32+
```
33+
For more detailed instructions please refer to [Installing Julia & Unfold.jl](@ref install_instruct).
34+
35+
36+
## Quick start
1337
There are four main model types
1438

1539
1. Timeexpansion **No**, Mixed **No** : `fit(UnfoldModel, [Any=>(f, -0.1:0.01:0.5)], evts, data_epoch)`
1640
1. Timeexpansion **Yes**, Mixed **No** : `fit(UnfoldModel, [Any=>(f, basisfunction)], evts, data)`
1741
1. Timeexpansion **No**, Mixed **Yes** : `fit(UnfoldModel, [Any=>(fLMM, -0.1:0.01:0.5)], evts, data_epoch)`
1842
1. Timeexpansion **Yes**, Mixed **Yes**: `fit(UnfoldModel, [Any=>(fLMM, basisfunction)], evts, data)`
1943

20-
## rERP model
2144

45+
## Usage example
46+
### rERP model
2247
```julia
2348
using Unfold
2449
using UnfoldSim
@@ -30,9 +55,9 @@ fit(UnfoldModel, [Any=>(f, basisfunction)], evts, data)
3055
nothing #hide
3156
```
3257

33-
## MixedModels
3458

35-
It is also possible to fit Linear Mixed Models using the sister-package `UnfoldMixedModels.jl`
59+
### MixedModels
60+
It is also possible to fit Linear Mixed Models using the sister-package [UnfoldMixedModels.jl](https://unfoldtoolbox.github.io/UnfoldDocs/UnfoldMixedModels.jl/stable/)
3661

3762
```julia
3863
using UnfoldMixedModels
@@ -46,3 +71,24 @@ fLMM = @formula 0 ~ 1 + condition + (1|subject) + (1|item)
4671
fit(UnfoldModel, [Any=>(f, times)], evts, data)
4772
nothing #hide
4873
```
74+
75+
## Where to start: Learning roadmap
76+
### 1. First step
77+
📌 Goal:
78+
🔗
79+
80+
### 2. Intermediate topics
81+
📌 Goal:
82+
🔗
83+
84+
### 3. Advanced topics
85+
📌 Goal:
86+
🔗
87+
88+
89+
## Statement of need
90+
```@raw html
91+
<!---
92+
Note: The statement of need is also used in the `README.md`. Make sure that they are synchronized.
93+
-->
94+
```

0 commit comments

Comments
 (0)