Welcome to the NeuroAnalyzer website

This is the home of NeuroAnalyzer.jl documentation and tutorials.

NeuroAnalyzer is a Julia toolbox for analyzing neurophysiological data. Currently it covers importing, editing, processing, visualizing, and analyzing EEG, MEP and EDA data. Preliminary functionality is also available for MEG, NIRS, ECoG, SEEG and iEEG recordings.

Various methods for modeling non-invasive brain stimulation protocols (tDCS, tACS, tRNS, tPCS, TMS, TUS, INS) will also be implemented (NeuroStim submodule). Another submodule, NeuroTester, will allow designing and running psychological studies. Certain neurophysiological data can be recorded using NeuroRecorder submodule.

NeuroAnalyzer contains a set of separate (high- and low-level) functions. Some interactive graphical user interface (GUI) functions are also available. NeuroAnalyzer functions can be combined into an analysis pipeline, i.e. a Julia script containing all steps of your analysis. This, combined with processing power of Julia language and easiness of distributing calculations across computing cluster, will make NeuroAnalyzer particularly useful for processing large amounts of neurophysiological data.

NeuroAnalyzer is a collaborative, non-commercial project, developed for researchers in psychiatry, neurology and neuroscience.

NeuroAnalyzer repository is located at Codeberg AdamWysokinski/NeuroAnalyzer.jl and mirrored at Github JuliaHealth/Neuroanalyzer.jl.

What you can do with NeuroAnalyzer

  1. Load neurophysiological recordings:
  2. Edit:
  3. Process:
  4. Analyze:
  5. Plot:

All computations are performed using the double-precision 64-bit floating point format. NeuroAnalyzer data is stored using standard Julia Array and can be easily exported as DataFrame. Thus, external processing of those data using Julia packages is readily available.

NeuroAnalyzer also includes NeuroRecorder, a set of functions for recording various neurophysiological signals:

NeuroTester modules implements various neuropsychological tests:

Why Julia?

There are many excellent MATLAB and Python based EEG/MEG/NIRS software (e.g. EEGLAB, Fieldtrip, Brainstorm, MNE). They have been developed for many years and are well established in the scientific community. Many state-of-the-art papers were published using data prepared using these programs.

However, compared with Python and MATLAB, there are many advantages of Julia, which underlie my decision to start developing such a toolbox in Julia.

I believe that Julia is the future of scientific computing and scientific data analysis. Major advantages of Julia are listed in Julia documentation.

  1. Julia is fast. In many situations Julia is considerably faster than Python (without having to use numba/cython) and MATLAB. Moreover, Julia provides unlimited scalability. Julia programs can easily be ran on a large cluster or across distributed computers.
  2. Julia is open-source and free. Increasing MATLAB licensing costs are prohibitive to individual researchers and many research institutions.
  3. From its very beginning Julia is being focused on scientific computations. Currently only Julia, C, C++ and Fortran belong to the HPC (High Performance Computing) Petaflop Club. Julia is designed for distributed and parallel computations, making it great for distributed analyzes of large data sets.
  4. Most of the Julia packages are written in pure Julia. It’s easier to understand and modify their code if you already know Julia.
  5. Julia is beautifully designed, making programming in Julia a pure pleasure. This elegant design makes Julia easy to read and write.

Benchmarks against MNE and EEGLAB are available here.

What’s new

Changelog and commit details are here.

What’s next

This roadmap of the future developments of NeuroAnalyzer is neither complete, nor in any particular order. You are encouraged to add new functions required for your study. You may also submit a feature request using Codeberg NeuroAnalyzer.jl repository page.

Hardware and software requirements

See this section for more details.

Documentation

Documentation is available in the following formats:

Known bugs

List of know, reported and fixed bugs is here.

Tutorials

If you are new to Julia, please take a look at some resources for Getting Started with Julia.

Quickstart: add NeuroAnalyzer from the Pkg REPL: pkg> add NeuroAnalyzer.

In Julia REPL, each NeuroAnalyzer function documentation is available via ?<function_name>, e.g. ?plot_psd. Since some function names are exported by other packages (e.g. plot by the Plots package), their use must be qualified: NeuroAnalyzer.plot().

It is recommended to start with the glossary, as it explains some terms specific for NeuroAnalyzer.

  1. Using NeuroAnalyzer
    1. Download and installation
    2. Generating and using sysimage
    3. General remarks
    4. Preferences
    5. Plugins
  2. Load data and electrode positions
    1. Load/save/import/export data
    2. Load/edit/preview electrode positions
  3. Edit
    1. Edit (1): copy, view/edit metadata, view properties/history
    2. Edit (2): edit channels/epochs, using markers
    3. Edit (3): bad channels/epochs: detect/trim signal/remove bad epochs/interpolate channels
    4. Edit (4): resample, band frequencies
    5. Edit (5): picks and clusters
    6. Edit (6): virtual channels and applying formula
  4. Process
    1. Process (1): reference (common, averaged, auricular, mastoid, Laplacian, custom montage)
    2. Process (2): filtering (FIR, IIR, Remez, moving average, moving median, polynomial, convolution)
    3. Process (3): demean, normalize, taper, convolution, PCA
    4. Process (4): remove electrode pops
    5. Process (5): ICA decomposition/reconstruction
    6. Process (6): interpolate bad channels
  5. Analyze
    1. Analyze (1): components
    2. Analyze (2): frequency domain
    3. Analyze (3): segments
    4. Analyze (4): coherence
    5. Analyze (5): lateralization index and asymmetry index
    6. Analyze (6): miscellaneous
  6. Plot
    1. Plot (1): plot multi-/single-channel signal, compare two signals
    2. Plot (2): plot frequency analysis (PSD: single-/multi-channel, Welch’s periodogram, multi-tapered, Morlet wavelet, 2d/3d)
    3. Plot (3): plot spectrogram (single-/multi-channel, regular, STFT, Morlet wavelet)
    4. Plot (4): complex/tiled plots
    5. Plot (5): filter response
    6. Plot (6): band powers
    7. Plot (7): auto/cross-correlation/covariance
    8. Plot (8): topographical maps
    9. Plot (9): interactive preview and edit
  7. Statistic
    1. Statistics (1): bootstrapping
  8. Misc
    1. Pipelines
    2. Study
    3. Calculate and plot PSD slope
    4. Stationarity
    5. Remove power line noise
    6. Animate
    7. HRV
  9. Other data types:
    1. MEPs
    2. ERPs
    3. fNIRS
    4. ECoG
    5. MEG
  10. NeuroRecorder:
    1. EDA
  11. NeuroTester:
    1. FTT
    2. TPT

Plugins

The list of available plugins is here.

Please let us know if you would like to add your plugin(s) to the list.

License

This software is licensed under The 2-Clause BSD License.

How to cite

If you use this software, please cite our article in the Journal of Open Source Software:

@article{Wysokiński_2025,
    doi = {10.21105/joss.07734},
    url = {https://doi.org/10.21105/joss.07734},
    year = {2025},
    publisher = {The Open Journal},
    volume = {10},
    number = {107},
    pages = {7734},
    author = {Adam Wysokiński},
    title = {NeuroAnalyzer: Julia toolbox for analyzing neurophysiological data},
    journal = {Journal of Open Source Software}
}

DOIs for specific version numbers are provided by Zenodo. To refer to the current version, use:

@software{NeuroAnalyzer,
    author = {Adam Wysokiński},
    title = {NeuroAnalyzer},
    publisher = {Zenodo},
    doi = {10.5281/zenodo.7372648},
    url = {https://doi.org/10.5281/zenodo.7372648}
}

Version numbers are: 0.yy.m (yy: last two digits of the year, m: number of the month). Stable versions are released at the beginning of the month indicated in the version number.

Financial support

If you would like to support the project financially, we have the Liberapay account: Donate using Liberapay

Contributing

Every contribution (bug reports, fixes, new ideas, feature requests or additions, speed optimization, better code, documentation improvements, typos, etc.) to the project is highly welcomed.

You are very welcome to raise issues and start pull requests. Bugs, suggestions and questions should be reported using the Codeberg AdamWysokinski/NeuroAnalyzer.jl (preferred method) or Github JuliaHealth/NeuroAnalyzer.jl issues page.

If you notice any bugs, such as crashing code, incorrect results or speed issues, please raise a Codeberg/GitHub issue. Before filing an issue please:

If you want to report a bug, include your version and system information, and all relevant information. If possible, condense your bug into the shortest example possible that the maintainers can replicate, a so called “minimal working example” or MWE.

If you want to suggest a new feature, for example functionality that other plotting packages offer already, include supplementary material such as example images if possible, so it’s clear what you are asking for.

When opening a pull request, please add a short but meaningful description of the changes/features you implemented. Moreover, please add tests (where appropriate) to ensure that your code is working as expected.

For each feature you want to contribute, please file a separate PR to keep the complexity down and time to merge short. Add PRs in draft mode if you want to discuss your approach first.

List of publications using NeuroAnalyzer

  1. Wysokiński A, Szczepocka E, Szczakowska A. Improved cognitive performance, increased theta, alpha, beta and decreased delta powers after cognitive rehabilitation augmented with tDCS in a patient with post-COVID-19 cognitive impairment (brain-fog). Psychiatry Research Case Reports. 2023 DOI: 10.1016/j.psycr.2023.100164
  2. Sochal M. et al. The relationship between sleep quality measured by polysomnography and selected neurotrophic factors. Journal of Clinical Medicine. 2024 DOI: 10.3390/jcm13030893
  3. Sochal M. et al. Circadian Rhythm Genes and Their Association with Sleep and Sleep Restriction. International Journal of Molecular Sciences. 2024 DOI: 10.3390/ijms251910445
  4. Datseris G, Zelko J. Physiological signal analysis and open science using the Julia language and associated software. Frontiers in Network Physiology. 2024 DOI: 10.3389/fnetp.2024.1478280

If you have used NeuroAnalyzer in your research, you are kindly asked to report the bibliographic description of your publication.

This website is maintained by Adam Wysokiński ORCID

UMED