neurokit2 · diff
git:20260611.1b8fae3 to v1.1
233 added, 263 removed. Audit A to A.
---
name: neurokit2
- description: Comprehensive biosignal processing toolkit for analyzing physiological data including ECG, EEG, EDA, RSP, PPG, EMG, and EOG signals. Use this skill when processing cardiovascular signals, brain activity, electrodermal responses, respiratory patterns, muscle activity, or eye movements. Applicable for heart rate variability analysis, event-related potentials, complexity measures, autonomic nervous system assessment, psychophysiology research, and multi-modal physiological signal integration.
- license: MIT license
- metadata: {"version": "1.0", "skill-author": "K-Dense Inc."}
+ description: Use NeuroKit2 to build or audit reproducible research workflows for physiological time-series preprocessing, event/interval analysis, multimodal alignment, variability, and complexity. Trigger when code imports neurokit2 or needs its current APIs, schemas, and method-aware validation—not for diagnosis or device validation.
+ license: MIT
+ compatibility: Python 3.10+ and uv; pinned workflows use NeuroKit2 0.2.13. Core processing needs NumPy, SciPy, pandas, scikit-learn, matplotlib, PyWavelets, requests, and setuptools; selected EEG, cvxEDA, plotting, file-format, and RQA features need separately locked optional packages.
+ allowed-tools: Read, Write, Edit, Bash, Glob
+ metadata:
+ version: "1.1"
+ skill-author: K-Dense Inc.
---
# NeuroKit2
- ## Overview
-
- NeuroKit2 is a comprehensive Python toolkit for processing and analyzing physiological signals (biosignals). Use this skill to process cardiovascular, neural, autonomic, respiratory, and muscular signals for psychophysiology research, clinical applications, and human-computer interaction studies.
-
- ## When to Use This Skill
+ ## Scope and evidence cutoff
- Apply this skill when working with:
- - **Cardiac signals**: ECG, PPG, heart rate variability (HRV), pulse analysis
- - **Brain signals**: EEG frequency bands, microstates, complexity, source localization
- - **Autonomic signals**: Electrodermal activity (EDA/GSR), skin conductance responses (SCR)
- - **Respiratory signals**: Breathing rate, respiratory variability (RRV), volume per time
- - **Muscular signals**: EMG amplitude, muscle activation detection
- - **Eye tracking**: EOG, blink detection and analysis
- - **Multi-modal integration**: Processing multiple physiological signals simultaneously
- - **Complexity analysis**: Entropy measures, fractal dimensions, nonlinear dynamics
+ Use this skill for method-aware, reproducible biosignal research with NeuroKit2. The
+ snapshot was checked on **2026-07-23** against:
- ## Core Capabilities
+ - stable PyPI **0.2.13**, released 2026-03-02;
+ - Python metadata (`>=3.10`; classifiers 3.10–3.14) and wheel dependencies;
+ - GitHub release notes/tags, `NEWS.rst`, source at tag `v0.2.13`;
+ - official API pages/examples (the live site identified itself as
+ `0.2.13.dev214`); and
+ - pinned 0.2.13 runtime signatures and synthetic output schemas.
- ### 1. Cardiac Signal Processing (ECG/PPG)
+ The live documentation can be ahead of the stable wheel. Prefer the pinned runtime
+ for reproducible work and name both versions if consulting development docs.
- Process electrocardiogram and photoplethysmography signals for cardiovascular analysis. See `references/ecg_cardiac.md` for detailed workflows.
+ ## Boundary
- **Primary workflows:**
- - ECG processing pipeline: cleaning → R-peak detection → delineation → quality assessment
- - HRV analysis across time, frequency, and nonlinear domains
- - PPG pulse analysis and quality assessment
- - ECG-derived respiration extraction
+ NeuroKit2 is a research and educational toolbox. Do **not** present its output as:
- **Key functions:**
- ```python
- import neurokit2 as nk
+ - a diagnosis, treatment recommendation, patient-monitoring decision, or alarm;
+ - validation, certification, or regulatory evidence for a medical device; or
+ - proof that a physiological construct is measured validly in a new sensor,
+ protocol, environment, population, or disease group.
- # Complete ECG processing pipeline
- signals, info = nk.ecg_process(ecg_signal, sampling_rate=1000)
+ Validate acquisition hardware, electrode/optode placement, units, sampling and clock
+ accuracy, preprocessing, detector/decomposition method, population, task, and
+ outcomes for the intended study. Preserve raw data and an auditable exclusion log.
+ Use deidentified local files only; do not place PHI in prompts, logs, examples, or
+ bundled fixtures.
- # Analyze ECG data (event-related or interval-related)
- analysis = nk.ecg_analyze(signals, sampling_rate=1000)
+ ## Reproducible installation
- # Comprehensive HRV analysis
- hrv = nk.hrv(peaks, sampling_rate=1000) # Time, frequency, nonlinear domains
+ ```bash
+ uv pip install "neurokit2==0.2.13"
```
- ### 2. Heart Rate Variability Analysis
-
- Compute comprehensive HRV metrics from cardiac signals. See `references/hrv.md` for all indices and domain-specific analysis.
-
- **Supported domains:**
- - **Time domain**: SDNN, RMSSD, pNN50, SDSD, and derived metrics
- - **Frequency domain**: ULF, VLF, LF, HF, VHF power and ratios
- - **Nonlinear domain**: Poincaré plot (SD1/SD2), entropy measures, fractal dimensions
- - **Specialized**: Respiratory sinus arrhythmia (RSA), recurrence quantification analysis (RQA)
+ For optional features, create a uv project, add only the packages actually required at
+ reviewed exact versions, and commit/review the resulting `uv.lock` before
+ `uv sync --locked`. NeuroKit2 exposes an upstream `full` extra, but this skill
+ intentionally does not install that floating transitive set in an automated workflow.
+ Optional capabilities can require MNE, cvxopt, Plotly, PyEMD, pyRQA, Pillow, OpenCV,
+ or file readers. Record the resolved environment with the analysis. Provision any MNE
+ data/template download as an explicit, checksummed study input. Do not install a moving
+ development branch for a reproducible study.
- **Key functions:**
- ```python
- # All HRV indices at once
- hrv_indices = nk.hrv(peaks, sampling_rate=1000)
+ ## Required data contract
- # Domain-specific analysis
- hrv_time = nk.hrv_time(peaks)
- hrv_freq = nk.hrv_frequency(peaks, sampling_rate=1000)
- hrv_nonlinear = nk.hrv_nonlinear(peaks, sampling_rate=1000)
- hrv_rsa = nk.hrv_rsa(peaks, rsp_signal, sampling_rate=1000)
- ```
+ Before processing, record:
- ### 3. Brain Signal Analysis (EEG)
+ 1. signal identity and sensor/channel configuration;
+ 2. native sampling rate in Hz and physical unit (or explicitly `arbitrary_unit`);
+ 3. clock, timestamp origin, drift correction, and synchronization evidence;
+ 4. polarity/orientation and acquisition-side filters/gain;
+ 5. missing samples, discontinuities, saturation, flatlines, motion, and annotations;
+ 6. whether event onsets are zero-based sample indices or seconds;
+ 7. planned preprocessing order, methods, parameters, exclusions, and outputs; and
+ 8. participant-level grouping needed to prevent leakage in later statistics.
- Analyze electroencephalography signals for frequency power, complexity, and microstate patterns. See `references/eeg.md` for detailed workflows and MNE integration.
+ Never infer units from a column name. Do not silently treat samples as milliseconds,
+ volts, microsiemens, or arbitrary units.
- **Primary capabilities:**
- - Frequency band power analysis (Delta, Theta, Alpha, Beta, Gamma)
- - Channel quality assessment and re-referencing
- - Source localization (sLORETA, MNE)
- - Microstate segmentation and transition dynamics
- - Global field power and dissimilarity measures
+ ## Core workflow
- **Key functions:**
- ```python
- # Power analysis across frequency bands
- power = nk.eeg_power(eeg_data, sampling_rate=250, channels=['Fz', 'Cz', 'Pz'])
+ ### 1. Inspect before transforming
- # Microstate analysis
- microstates = nk.microstates_segment(eeg_data, n_microstates=4, method='kmod')
- static = nk.microstates_static(microstates)
- dynamic = nk.microstates_dynamic(microstates)
+ ```bash
+ python skills/neurokit2/scripts/inspect_signal.py \
+ --input recording.csv --root . --deidentified \
+ --columns ECG,RSP,EDA --time-column time_s \
+ --units ECG=mV,RSP=a.u.,EDA=uS
```
- ### 4. Electrodermal Activity (EDA)
-
- Process skin conductance signals for autonomic nervous system assessment. See `references/eda.md` for detailed workflows.
-
- **Primary workflows:**
- - Signal decomposition into tonic and phasic components
- - Skin conductance response (SCR) detection and analysis
- - Sympathetic nervous system index calculation
- - Autocorrelation and changepoint detection
+ The inspector is bounded and emits no row values or paths. Resolve non-monotonic time,
+ duplicate samples, gaps, non-finite values, flat runs, and sampling-rate disagreement
+ before filtering.
- **Key functions:**
- ```python
- # Complete EDA processing
- signals, info = nk.eda_process(eda_signal, sampling_rate=100)
+ ### 2. Preserve preprocessing order
- # Analyze EDA data
- analysis = nk.eda_analyze(signals, sampling_rate=100)
+ Use this default reasoning order, adapting it to the acquisition and cited method:
- # Sympathetic nervous system activity
- sympathetic = nk.eda_sympathetic(signals, sampling_rate=100)
- ```
+ 1. preserve immutable raw signal and annotations;
+ 2. verify time base, units, polarity, clipping, gaps, and artifacts;
+ 3. segment at long gaps; only interpolate short gaps under a declared policy;
+ 4. apply modality-specific cleaning at the native sampling rate;
+ 5. detect peaks/onsets or decompose components;
+ 6. inspect quality outputs and raw overlays;
+ 7. correct peaks only with logged categories and sensitivity checks;
+ 8. derive rates/features;
+ 9. align continuous modalities on a declared common time grid; and
+ 10. map event indices to that grid, epoch, baseline, and analyze.
- ### 5. Respiratory Signal Processing (RSP)
+ Do not resample binary markers or peak-index arrays as ordinary continuous signals.
+ Map their timestamps to the target grid. Filtering and interpolation can create edge
+ artifacts and false precision; retain masks for padded, missing, and rejected regions.
- Analyze breathing patterns and respiratory variability. See `references/rsp.md` for detailed workflows.
+ ### 3. Treat schemas as runtime observations
- **Primary capabilities:**
- - Respiratory rate calculation and variability analysis
- - Breathing amplitude and symmetry assessment
- - Respiratory volume per time (fMRI applications)
- - Respiratory amplitude variability (RAV)
+ Return columns depend on NeuroKit2 version, function, method, signal availability, and
+ analysis mode. Never claim that one column list is universal.
- **Key functions:**
```python
- # Complete RSP processing
- signals, info = nk.rsp_process(rsp_signal, sampling_rate=100)
-
- # Respiratory rate variability
- rrv = nk.rsp_rrv(signals, sampling_rate=100)
-
- # Respiratory volume per time
- rvt = nk.rsp_rvt(signals, sampling_rate=100)
+ signals, info = nk.ecg_process(ecg, sampling_rate=250)
+ observed_schema = {
+ "columns": list(signals.columns),
+ "info_keys": sorted(info),
+ }
```
- ### 6. Electromyography (EMG)
-
- Process muscle activity signals for activation detection and amplitude analysis. See `references/emg.md` for workflows.
-
- **Key functions:**
- ```python
- # Complete EMG processing
- signals, info = nk.emg_process(emg_signal, sampling_rate=1000)
+ Persist the observed schema with package version, method parameters, sampling rate, and
+ quality/exclusion summary. Reference files list verified default schemas for 0.2.13,
+ not guarantees for every method.
- # Muscle activation detection
- activation = nk.emg_activation(signals, sampling_rate=1000, method='threshold')
- ```
+ ## Current patterns
- ### 7. Electrooculography (EOG)
+ ### ECG, corrected peaks, and duration-aware HRV
- Analyze eye movement and blink patterns. See `references/eog.md` for workflows.
+ In stable 0.2.13, `ecg_process()` performs cleaning, R-peak detection with
+ `correct_artifacts=True`, rate, default `averageQRS` quality, DWT delineation, and phase.
- **Key functions:**
```python
- # Complete EOG processing
- signals, info = nk.eog_process(eog_signal, sampling_rate=500)
-
- # Extract blink features
- features = nk.eog_features(signals, sampling_rate=500)
+ signals, info = nk.ecg_process(ecg, sampling_rate=250, method="neurokit")
+ time_hrv = nk.hrv_time(info, sampling_rate=250)
```
- ### 8. General Signal Processing
-
- Apply filtering, decomposition, and transformation operations to any signal. See `references/signal_processing.md` for comprehensive utilities.
-
- **Key operations:**
- - Filtering (lowpass, highpass, bandpass, bandstop)
- - Decomposition (EMD, SSA, wavelet)
- - Peak detection and correction
- - Power spectral density estimation
- - Signal interpolation and resampling
- - Autocorrelation and synchrony analysis
-
- **Key functions:**
- ```python
- # Filtering
- filtered = nk.signal_filter(signal, sampling_rate=1000, lowcut=0.5, highcut=40)
+ Inspect `ECG_R_Peaks_Uncorrected` and `ECG_fixpeaks_*`; a corrected series is not
+ automatically a valid NN series. For frequency/nonlinear HRV, enforce metric-specific
+ duration and beat-count requirements. Five minutes is the conventional short-term
+ reference; ULF is a long-recording measure, and VLF interpretation from short records
+ is unsafe. Do not interpret LF/HF as a direct sympathovagal balance. PPG pulse-rate
+ variability is not interchangeable with ECG HRV.
- # Peak detection
- peaks = nk.signal_findpeaks(signal)
+ Use the bounded pipeline:
- # Power spectral density
- psd = nk.signal_psd(signal, sampling_rate=1000)
+ ```bash
+ python skills/neurokit2/scripts/ecg_hrv_pipeline.py \
+ --synthetic --sampling-rate 250 --duration 300 \
+ --domains time,frequency,nonlinear
```
- ### 9. Complexity and Entropy Analysis
-
- Compute nonlinear dynamics, fractal dimensions, and information-theoretic measures. See `references/complexity.md` for all available metrics.
+ ### EDA with explicit decomposition
- **Available measures:**
- - **Entropy**: Shannon, approximate, sample, permutation, spectral, fuzzy, multiscale
- - **Fractal dimensions**: Katz, Higuchi, Petrosian, Sevcik, correlation dimension
- - **Nonlinear dynamics**: Lyapunov exponents, Lempel-Ziv complexity, recurrence quantification
- - **DFA**: Detrended fluctuation analysis, multifractal DFA
- - **Information theory**: Fisher information, mutual information
+ The stable default `eda_process(method="neurokit")` uses high-pass tonic/phasic
+ decomposition, not cvxEDA. Choose and report decomposition explicitly:
- **Key functions:**
```python
- # Multiple complexity metrics at once
- complexity_indices = nk.complexity(signal, sampling_rate=1000)
-
- # Specific measures
- apen = nk.entropy_approximate(signal)
- dfa = nk.fractal_dfa(signal)
- lyap = nk.complexity_lyapunov(signal, sampling_rate=1000)
+ clean = nk.eda_clean(eda, sampling_rate=100, method="neurokit")
+ components = nk.eda_phasic(clean, sampling_rate=100, method="highpass")
+ markers, info = nk.eda_peaks(
+ components["EDA_Phasic"],
+ sampling_rate=100,
+ method="neurokit",
+ amplitude_min=0.1,
+ )
```
- ### 10. Event-Related Analysis
-
- Create epochs around stimulus events and analyze physiological responses. See `references/epochs_events.md` for workflows.
-
- **Primary capabilities:**
- - Epoch creation from event markers
- - Event-related averaging and visualization
- - Baseline correction options
- - Grand average computation with confidence intervals
-
- **Key functions:**
- ```python
- # Find events in signal
- events = nk.events_find(trigger_signal, threshold=0.5)
-
- # Create epochs around events
- epochs = nk.epochs_create(signals, events, sampling_rate=1000,
- epochs_start=-0.5, epochs_end=2.0)
+ For `neurokit`/`kim2004`, `amplitude_min` is relative to the largest detected response;
+ it is not an absolute microsiemens threshold. cvxEDA needs optional `cvxopt`.
- # Average across epochs
- grand_average = nk.epochs_average(epochs)
+ ```bash
+ python skills/neurokit2/scripts/eda_pipeline.py \
+ --synthetic --sampling-rate 100 --duration 60 \
+ --phasic-method highpass --peak-method neurokit
```
- ### 11. Multi-Signal Integration
+ ### Events, epochs, and baseline
- Process multiple physiological signals simultaneously with unified output. See `references/bio_module.md` for integration workflows.
+ `events_find()` reports zero-based sample onsets; duration/spacing arguments are in
+ samples. `epochs_create()` takes epoch limits in seconds.
- **Key functions:**
```python
- # Process multiple signals at once
- bio_signals, bio_info = nk.bio_process(
- ecg=ecg_signal,
- rsp=rsp_signal,
- eda=eda_signal,
- emg=emg_signal,
- sampling_rate=1000
+ events = nk.events_find(trigger, threshold=0.5, duration_min=2)
+ epochs = nk.epochs_create(
+ signals,
+ events,
+ sampling_rate=100,
+ epochs_start=-0.2,
+ epochs_end=0.8,
+ baseline_correction=False,
)
-
- # Analyze all processed signals
- bio_analysis = nk.bio_analyze(bio_signals, sampling_rate=1000)
```
- ## Analysis Modes
-
- NeuroKit2 automatically selects between two analysis modes based on data duration:
+ Plan sample-exact windows first:
- **Event-related analysis** (< 10 seconds):
- - Analyzes stimulus-locked responses
- - Epoch-based segmentation
- - Suitable for experimental paradigms with discrete trials
+ ```bash
+ python skills/neurokit2/scripts/plan_epochs.py \
+ --events 1000,2500,4000 --event-unit samples \
+ --sampling-rate 100 --recording-samples 5000 \
+ --epoch-start -0.2 --epoch-end 0.8 \
+ --baseline-start -0.2 --baseline-end 0
+ ```
- **Interval-related analysis** (≥ 10 seconds):
- - Characterizes physiological patterns over extended periods
- - Resting state or continuous activities
- - Suitable for baseline measurements and long-term monitoring
+ In 0.2.13 the epoch slice is end-exclusive, but the generated floating time index
+ includes `epochs_end`. Built-in baseline correction subtracts the epoch mean from its
+ start through `t=0`; use manual correction for a narrower prespecified baseline.
+ Boundary epochs are padded and can contain NaN. Decide drop/pad/error before analysis.
- Most `*_analyze()` functions automatically choose the appropriate mode.
+ ### RSA and multimodal processing
- ## Installation
+ `bio_process()` assumes all inputs already share one sampling rate and alignment. It
+ does not resample, synchronize, estimate drift, or create nested modality dictionaries;
+ its `info` output is flat. Unequal lengths are concatenated by index and can introduce
+ NaN. RSA is added only when synchronized ECG and RSP are present.
- ```bash
- uv pip install neurokit2
- ```
+ Validate a strict local manifest before calling it:
- For development version:
```bash
- uv pip install https://github.com/neuropsychology/NeuroKit/zipball/dev
+ python skills/neurokit2/scripts/validate_multimodal.py \
+ --manifest streams.json --root . --deidentified
```
- ## Common Workflows
+ After independent modality QC and alignment:
- ### Quick Start: ECG Analysis
```python
- import neurokit2 as nk
+ bio_signals, bio_info = nk.bio_process(
+ ecg=ecg_aligned,
+ rsp=rsp_aligned,
+ eda=eda_aligned,
+ sampling_rate=common_rate,
+ )
+ rsa_summary = nk.hrv_rsa(
+ bio_signals,
+ bio_signals,
+ rpeaks=bio_info,
+ sampling_rate=common_rate,
+ continuous=False,
+ )
+ ```
- # Load example data
- ecg = nk.ecg_simulate(duration=60, sampling_rate=1000)
+ Summary RSA is a dictionary; `continuous=True` returns a DataFrame with `RSA_P2T` and
+ `RSA_Gates` in the verified default workflow. Co-record respiration and report its
+ rate/depth/context; RSA is not a direct, context-free measure of vagal tone.
- # Process ECG
- signals, info = nk.ecg_process(ecg, sampling_rate=1000)
+ ### Complexity returns values plus metadata
- # Analyze HRV
- hrv = nk.hrv(info['ECG_R_Peaks'], sampling_rate=1000)
+ Most complexity functions in 0.2.13 return `(value, info)`. The convenience function
+ also returns two objects:
- # Visualize
- nk.ecg_plot(signals, info)
+ ```python
+ features, details = nk.complexity(signal) # default which="makowski2022"
+ sampen, sampen_info = nk.entropy_sample(signal)
+ dfa, dfa_info = nk.fractal_dfa(signal)
```
- ### Multi-Modal Analysis
- ```python
- # Process multiple signals
- bio_signals, bio_info = nk.bio_process(
- ecg=ecg_signal,
- rsp=rsp_signal,
- eda=eda_signal,
- sampling_rate=1000
- )
+ The default convenience selection is not “all measures.” Complexity estimates are
+ sensitive to length, stationarity, normalization, delay, dimension, tolerance, scale,
+ and implementation. Predefine them and run sensitivity/surrogate analyses.
- # Analyze all signals
- results = nk.bio_analyze(bio_signals, sampling_rate=1000)
- ```
+ ## Bundled command-line helpers
- ### Event-Related Potential
- ```python
- # Find events
- events = nk.events_find(trigger_channel, threshold=0.5)
+ All helpers reject URLs, path traversal, and symlinks; bound bytes/rows/channels; refuse
+ overwrite unless `--force`; use lazy scientific imports so `--help` works without
+ NeuroKit2; never use pickle; and produce deterministic JSON/CSV. Real-data commands
+ require `--deidentified`.
- # Create epochs
- epochs = nk.epochs_create(processed_signals, events,
- sampling_rate=1000,
- epochs_start=-0.5, epochs_end=2.0)
+ | Helper | Purpose |
+ |---|---|
+ | `scripts/generate_synthetic.py` | Dependency-free deterministic CSV fixtures |
+ | `scripts/inspect_signal.py` | Bounded CSV/time/gap/flatline inspection |
+ | `scripts/ecg_hrv_pipeline.py` | Pinned ECG, quality, peak-correction, HRV workflow |
+ | `scripts/eda_pipeline.py` | Explicit cleaning, decomposition, SCR workflow |
+ | `scripts/plan_epochs.py` | Sample-exact event, boundary, baseline planner |
+ | `scripts/validate_multimodal.py` | Strict units/rates/clocks/alignment schema validator |
- # Event-related analysis for each signal type
- ecg_epochs = nk.ecg_eventrelated(epochs)
- eda_epochs = nk.eda_eventrelated(epochs)
+ Generate a fixture without exposing participant data:
+
+ ```bash
+ python skills/neurokit2/scripts/generate_synthetic.py \
+ --output synthetic.csv --root . --duration 30 \
+ --sampling-rate 250 --seed 42
```
- ## References
+ ## Security note
- This skill includes comprehensive reference documentation organized by signal type and analysis method:
+ No example or helper uses Python `eval()` or `exec()`. NeuroKit2 names such as
+ `eeg_*`, `events_*`, and `*_eventrelated()` are ordinary library calls. If a static
+ scanner reports an eval/exec pattern based on a substring, inspect the exact line and
+ record it as a scanner false positive only after confirming no dynamic execution exists.
- - **ecg_cardiac.md**: ECG/PPG processing, R-peak detection, delineation, quality assessment
- - **hrv.md**: Heart rate variability indices across all domains
- - **eeg.md**: EEG analysis, frequency bands, microstates, source localization
- - **eda.md**: Electrodermal activity processing and SCR analysis
- - **rsp.md**: Respiratory signal processing and variability
- - **ppg.md**: Photoplethysmography signal analysis
- - **emg.md**: Electromyography processing and activation detection
- - **eog.md**: Electrooculography and blink analysis
- - **signal_processing.md**: General signal utilities and transformations
- - **complexity.md**: Entropy, fractal, and nonlinear measures
- - **epochs_events.md**: Event-related analysis and epoch creation
- - **bio_module.md**: Multi-signal integration workflows
+ ## References
- Load specific reference files as needed using the Read tool to access detailed function documentation and parameters.
+ Read only the files needed for the modality or decision:
+ All bundled Markdown paths below are under `references/`; this skill has no
+ `templates/` or `assets/` reference paths.
- ## Additional Resources
+ | File | Contents |
+ |---|---|
+ | `references/signal_processing.md` | Filters, gaps, resampling, peaks, PSD, schemas |
+ | `references/epochs_events.md` | Event indexing, epoch boundaries, baselines |
+ | `references/ecg_cardiac.md` | ECG process, quality, delineation, peak correction |
+ | `references/hrv.md` | HRV/RSA inputs, duration, ectopy, interpretation |
+ | `references/eda.md` | Cleaning, decomposition, SCR detection |
+ | `references/emg.md` | EMG cleaning, amplitude, activation |
+ | `references/eog.md` | EOG polarity, MNE default, blink features |
+ | `references/eeg.md` | EEG/MNE helpers, power, QC, microstates |
+ | `references/ppg.md` | PPG methods, quality semantics, PRV limitations |
+ | `references/rsp.md` | Respiration polarity, rate, RRV/RVT/RAV |
+ | `references/bio_module.md` | Multimodal alignment and `bio_*` schemas |
+ | `references/complexity.md` | Tuple returns, parameter sensitivity, RQA |
- - Official Documentation: https://neuropsychology.github.io/NeuroKit/
- - GitHub Repository: https://github.com/neuropsychology/NeuroKit
- - Publication: Makowski et al. (2021). NeuroKit2: A Python toolbox for neurophysiological signal processing. Behavior Research Methods. https://doi.org/10.3758/s13428-020-01516-y
+ ## Primary sources checked 2026-07-23
+ - [PyPI 0.2.13](https://pypi.org/project/neurokit2/)
+ - [Official documentation](https://neuropsychology.github.io/NeuroKit/)
+ - [API index](https://neuropsychology.github.io/NeuroKit/functions/index.html)
+ - [GitHub releases](https://github.com/neuropsychology/NeuroKit/releases)
+ - [Makowski et al. (2021), NeuroKit2](https://doi.org/10.3758/s13428-020-01516-y)
+ - [Pham et al. (2021), HRV tutorial](https://doi.org/10.3390/s21123998)
+ - [Makowski et al. (2022), complexity comparison](https://doi.org/10.3390/e24081036)
+ - [SPR guideline index](https://sprweb.org/guidelines-papers)
+ - [Quigley et al. (2024), HR/HRV guidelines](https://doi.org/10.1111/psyp.14604)