diff --git a/README.md b/README.md index 21ed6b7..d8e4da5 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # UnfoldStats -[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://unfoldtoolbox.github.io/UnfoldStats.jl/stable/) -[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://unfoldtoolbox.github.io/UnfoldStats.jl/dev/) +[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://unfoldtoolbox.github.io/UnfoldDocs/UnfoldStats.jl/stable/) +[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://unfoldtoolbox.github.io/UnfoldDocs/UnfoldStats.jl/dev/) [![Build Status](https://github.com/unfoldtoolbox/UnfoldStats.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/unfoldtoolbox/UnfoldStats.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Coverage](https://codecov.io/gh/unfoldtoolbox/UnfoldStats.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/unfoldtoolbox/UnfoldStats.jl) -|rERP|EEG visualisation|EEG Simulations|BIDS pipeline|Decode EEG data|Statistical testing| -|---|---|---|---|---|---| -| | ||||| +|Estimation|Visualisation|Simulation|BIDS pipeline|Decoding|Statistics|MixedModelling| +|---|---|---|---|---|---|---| +| Unfold.jl Logo | UnfoldMakie.jl Logo|UnfoldSim.jl Logo|UnfoldBIDS.jl Logo|UnfoldDecode.jl Logo|UnfoldStats.jl Logo|UnfoldMixedModels.jl logo| A toolbox for statistical testing of EEG/ERP data and Unfold.jl models. Build on the [Unfold](https://github.com/unfoldtoolbox/unfold.jl/). diff --git a/docs/make.jl b/docs/make.jl index bbf6008..82d7569 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -38,7 +38,12 @@ makedocs(; "Two-stage multi parameter test (Hotelling's T-squared test)" => "generated/tutorial/test_splines.md", "**MixedModels** EEG + Cluster permutation test" => "generated/tutorial/lmm_clusterdepth.md", ], + "API / Docstrings" => "api.md", ], ) -deploydocs(; repo = "github.com/unfoldtoolbox/UnfoldStats.jl", devbranch = "main", push_preview = true) +deploydocs(; + repo = "github.com/unfoldtoolbox/UnfoldStats.jl", + devbranch = "main", + push_preview = true, +) diff --git a/docs/src/api.md b/docs/src/api.md new file mode 100644 index 0000000..c390334 --- /dev/null +++ b/docs/src/api.md @@ -0,0 +1,8 @@ +# API / Docstrings + +```@index +``` + +```@autodocs +Modules = [UnfoldStats] +``` \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index 0388451..9ec1768 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -2,13 +2,46 @@ CurrentModule = UnfoldStats ``` -# UnfoldStats +# UnfoldStats.jl Documentation +Welcome to [UnfoldStats.jl](https://github.com/unfoldtoolbox/UnfoldStats.jl): a Julia package for statistical testing of EEG/ERP data and [Unfold.jl](https://github.com/unfoldtoolbox/Unfold.jl) models. -Documentation for [UnfoldStats](https://github.com/unfoldtoolbox/UnfoldStats.jl). +```@raw html +
+
+``` + +## Key features +TBD -```@index +## Installation +```julia-repl +julia> using Pkg; Pkg.add("UnfoldStats") ``` +For more detailed instructions please refer to [Installing Julia & Unfold Packages](https://unfoldtoolbox.github.io/UnfoldDocs/main/installation/). + + +## Usage example +TBD + +## Where to start: Learning roadmap +### 1. First steps +📌 Goal: TBD \ +🔗 TBD + +### 2. Intermediate topics +📌 Goal: TBD \ +🔗 TBD + +### 3. Advanced topics +📌 Goal: TBD \ +🔗 TBD + + +## Statement of need +TBD -```@autodocs -Modules = [UnfoldStats] +```@raw html + ```