Data

Tools

Indexes

Applications

Experiments

Open Source Science

UnfoldDecode

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

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (8.3%) to scientific vocabulary

Keywords

decoding eeg julia overlap-correction
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: unfoldtoolbox
  • License: mit
  • Language: Julia
  • Default Branch: main
  • Homepage:
  • Size: 265 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 5
  • Open Issues: 7
  • Releases: 2
Topics
decoding eeg julia overlap-correction
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

logo_UnfoldDecode jl_120px

Stable Documentation In development documentation Build Status Test workflow status Lint workflow Status Docs workflow Status Coverage DOI Contributor Covenant All Contributors

|rERP|EEG visualisation|EEG Simulations|BIDS pipeline|Decode EEG data|Statistical testing| |---|---|---|---|---|---| | unfold | UnfoldMakie|UnfoldSim|UnfoldBIDS|UnfoldDecode|UnfoldStats|

Beta-stage toolbox to decode ERPs with overlap, e.g. from eye-tracking experiments.

[!WARNING] Still little unit-tests implemented as of 2025-02-28 - use at your own risk!

Currently the following algorithms are implemented:

¹ actually any MLJ supported classification/regression model is already supported

Install

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

UnfoldDecode

Not yet registered thus you have to do:

julia using Pkg Pkg.add(url="https://github.com/unfoldtoolbox/UnfoldDecode.jl") using UnfoldDecode

once it is registered, this will simplify to Pkg.add("UnfoldDecode")

Quickstart

```julia LDA = @load LDA pkg=MultivariateStats

des = Dict("fixation" => (@formula(0~1+condition+continuous),firbasis((-0.1,1.),100))); uf_lda = fit(UnfoldDecodingModel,des,evt,dat,LDA(),"fixation"=>:condition) ```

Does the trick - you should probably do an Unfold.jl tutorial first though!

Loading Data

have a look at PyMNE.jl to read the data. You need a data-matrix + DataFrames.jl event table (similar to EEGlabs EEG.events)

Limitations

  • Not thoroughly tested, no unit-tests yet!
  • Missing features: e.g. No time generalization is available, but straight forward to implement with the current tooling.

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).
  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 with a reference to docs/src/generated/FOLDER/FILENAME.md.

How to Cite

If you use UnfoldDecode.jl in your work, please cite using the reference given in CITATION.cff AND the respective algorithm.

Acknowledgements

Funded by Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) under Germany´s Excellence Strategy – EXC 2075 – 390740016

Contributors

This project follows the all-contributors specification.

Contributions of any kind welcome! You can find the emoji key for the contributors here.

Owner

  • Name: unfoldtoolbox
  • Login: unfoldtoolbox
  • Kind: organization
  • Email: info@unfoldtoolbox.org

Unfold your potentials...

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: UnfoldDecode.jl
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Benedikt
    family-names: Ehinger
    email: benedikt.ehinger@vis.uni-stuttgart.de
    affiliation: University of Stuttgart
    orcid: 'https://orcid.org/0000-0002-6276-3332'
repository-code: 'https://github.com/unfoldtoolbox/UnfoldDecode.jl'
license: MIT

GitHub Events

Total
  • Create event: 3
  • Release event: 2
  • Issues event: 4
  • Issue comment event: 4
  • Push event: 21
  • Pull request event: 7
  • Fork event: 1
Last Year
  • Create event: 3
  • Release event: 2
  • Issues event: 4
  • Issue comment event: 4
  • Push event: 21
  • Pull request event: 7
  • Fork event: 1

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 2
juliahub.com: UnfoldDecode
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent repos count: 8.5%
Average: 22.6%
Dependent packages count: 36.7%
Last synced: 6 months ago