acti-data-analyzer 1.0.1

A library for processing and analyzing actigraphic data.

ADA – Actigraphic Data Analyzer

ADA stands for Actigraphic Data Analyzer, coincidentally being also the name of the first programmer in the world. It is an open source Python module for processing, analyzing and visualizing actigraphic data, with the main focus on bedtime sleep/wake classification and circadian rhythms analysis. ADA is usable in form of a python package, and in form of standalone application with graphical interface (GUI).

Installation

Python 3.11 or higher is required. To install the module use pip:

pip install acti-data-analyzer

The GUI for Windows 10 and Windows 11 is availabe as a standalone executable from TODO WHERRE IT WILL BE??.

Alternatively, GUI can be run on any system as a Python script, best within a venv. To do so:

• Download the run_gui.py file from this repository
• Install ada with GUI using pip install acti-data-analyzer[gui]
• Run the script from the terminal

Alternatively, one may use following commands in the terminal to avoid manual downloading of run_gui.py:

• Install the GUI dependencies using pip install acti-data-analyzer[gui]
• Activate python by typing python
• Import the main using from ada_gui.gui import main
• Activate GUI using main()

Main features

• Reading and writing data from:
  • GENEActiv .bin and .csv files
  • Actigraph Corp .gt3x and .csv files
  • The MESA dataset.
• Converting data to native .ada format (much more efficient in terms of disk space and reading speed).
• Multiple algorithms allowing collapsing into epochs:
  • MIMS
  • ActivityIndex
  • ENMO
  • Resampling
  • Cole-Kripke
• Sleep/wake scoring using multiple algorithms:
  • Cole-Kripke
  • Webster
  • Scripps Clinic
  • UCSD
  • Sazonov
  • Unified Filter, with possibility of custom filter construction.
• Estimating multiple sleep metrics:
  • Sleep efficiency
  • Sleep fragmentation index
  • Sleep onset latency
  • Wake after sleep onset
  • And more.
• Assessing circadian rhythms:
  • Single and multi-component cosinor in linear and nonlinear variants
  • Sigmoidally-transformed cosinor
  • Spectrum estimator using autoregressive model
  • Detrended Fluctuation Analysis
  • Nonparametric measures: Interdaily Stability, Intradaily Variability, M10, L5.
• Easy to read and analyze summaries of sleep/wake and circadian assessments for multiple subjects.
• Automatic and customizable synchronization of actigraphic data with PSG staging.
• Plotting of all analysis steps.

Full documentation together with usage tutorial can be found under the link.

Acknowledgments

pygt3x source code included in ADA is developed under the GPL-3.0 license by the Actigraph team. The original repository can be found under the link.