https://github.com/unfoldtoolbox/unfoldstats.jl

https://github.com/unfoldtoolbox/unfoldstats.jl

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/unfoldtoolbox/unfoldstats.jl
• Owner: unfoldtoolbox
• License: mit
• Created: 2023-11-07T15:16:51.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-06-25T09:00:21.000Z (about 1 year ago)
• Last Synced: 2025-09-05T00:51:59.665Z (11 months ago)
• Language: Julia
• Size: 5.34 MB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# 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/)

[![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|

|---|---|---|---|---|---|

|  | |||||

A toolbox for statistical testing of EEG/ERP data and Unfold.jl models.

Build on the [Unfold](https://github.com/unfoldtoolbox/unfold.jl/).

> [!CAUTION]

> This package is work in progress. We have not (yet) extensively checked the validity and correctness of the statistical tests. While we think these are valid approaches, we have ongoing studies investigating whether this is actually the case. If you notice some unexpected behavior please open an issue!

## Install

### Installing Julia

Click to expand

The recommended way to install julia is [juliaup](https://github.com/JuliaLang/juliaup).

It allows you to, e.g., easily update Julia at a later point, but also test out alpha/beta versions etc.

TL:DR; If you dont want to read the explicit instructions, just copy the following command

#### Windows

AppStore -> JuliaUp,  or `winget install julia -s msstore` in CMD

#### Mac & Linux

`curl -fsSL https://install.julialang.org | sh` in any shell

### Installing Unfold

```julia

using Pkg

Pkg.add("UnfoldStats")

```

### Contributions

Contributions are very welcome. These could be typos, bugreports, feature-requests, speed-optimization, new solvers, better code, better documentation.

### How-to Contribute

You are very welcome to raise issues and start pull requests!

### Adding Documentation

1. We recommend to write a Literate.jl document and place it in `docs/literate/FOLDER/FILENAME.jl` with `FOLDER` being `HowTo`, `Explanation`, `Tutorial` or `Reference` ([recommended reading on the 4 categories](https://documentation.divio.com/)).

2. Literate.jl converts the `.jl` file to a `.md` automatically and places it in `docs/src/generated/FOLDER/FILENAME.md`.

3. Edit [make.jl](https://github.com/unfoldtoolbox/Unfold.jl/blob/main/docs/make.jl) with a reference to `docs/src/generated/FOLDER/FILENAME.md`.

## Citation

If you make use of these statistics, please cite:

## Contributors

  

    

      
Judith Schepers
🚇 ⚠️ 💻

    

  

This project follows the [all-contributors](https://allcontributors.org/docs/en/specification) specification. 

Contributions of any kind welcome!

You can find the emoji key for the contributors [here](https://github.com/unfoldtoolbox/Unfold.jl/blob/main/docs/contrib-emoji.md)

## Acknowledgements

## Citing

See [`CITATION.bib`](CITATION.bib) for the relevant reference(s).