Skip to main content

Analysis package for actigraphy data

Project description

https://img.shields.io/badge/License-GPL%20v3-blue.svg https://gitlab.com/ghammad/pyActigraphy/badges/master/pipeline.svg https://gitlab.com/ghammad/pyActigraphy/badges/master/coverage.svg https://img.shields.io/pypi/v/pyActigraphy.svg https://zenodo.org/badge/DOI/10.5281/zenodo.2537921.svg

pyActigraphy

Open-source python package for actigraphy data analysis.

This package is meant to provide a comprehensive set of tools to:

  • read actigraphy raw data files with various formats
  • calculate typical wake/sleep cycle-related variables (ex: IS, IV, …)
  • perform complex analyses (ex: FDA, SSA, HMM, …)

Requirements

  • python 3.X
  • joblib
  • pandas
  • numba
  • numpy
  • pyexcel
  • pyexcel-ods3
  • scipy
  • statsmodels

Installation

In a (bash) shell, simply type:

  • For users:
pip install pyActigraphy

To update the package:

pip install -U pyActigraphy

It is strongly recommended to use the latest version of the pyActigraphy package.

  • For developers:
git clone git@github.com:ghammad/pyActigraphy.git
cd pyActigraphy/
git checkout develop
pip install -e .

Quick start

The following example illustrates how to calculate the interdaily stability with the pyActigraphy package:

>>> import pyActigraphy
>>> rawAWD = pyActigraphy.io.read_raw_awd('/path/to/your/favourite/file.AWD')
>>> rawAWD.IS()
0.6900175913031027
>>> rawAWD.IS(freq='30min', binarize=True, threshold=4)
0.6245582891144925
>>> rawAWD.IS(freq='1H', binarize=False)
0.5257020914453097

Contributing

There are plenty of ways to contribute to this package, including (but not limiting to):

  • report bugs (and, ideally, how to reproduce the bug)
  • suggest improvements
  • improve the documentation
  • hug or high-five the authors when you meet them!

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU GPL-3.0 License - see the LICENSE file for details

Acknowledgments

  • Aubin Ardois @aardoi developed the first version of the MTN class during his internship at the CRC, in May-August 2018.
  • The CRC colleagues for their support, ideas, etc.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyActigraphy, version 0.2
Filename, size File type Python version Upload date Hashes
Filename, size pyActigraphy-0.2-py3-none-any.whl (376.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pyActigraphy-0.2.tar.gz (349.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page