Skip to main content

Frametree: a framework for analysing datasets stored in trees of file objects "in-place"

Project description

FrameTree

Tests Codecov Python versions Latest Version Docs

FrameTree is Python framework that is used to map categorical data organised into trees (e.g. MRI sessions for multiple subjects and visits, saved in a file-system directory) onto virtual "data frames" for analysis. Cells in these data frames can be scalars, arrays or a set of files and/or directories stored at each node across a level in the given tree. Derivitives are stored along with the parameters used to derive them back into the store for reference and reuse by subsequent analysis steps. Extracted metrics can be exported to actual data frames for statistical analysis.

Documentation

Detailed documentation on FrameTree can be found at https://frametree.readthedocs.io

Quick Installation

FrameTree can be installed for Python 3 using pip::

$ python3 -m pip install frametree

Extensions

Support for specific specific repository software or data structures (e.g. XNAT or BIDS) are provided by extension packages (see frametree-xnat and frametree-bids).

License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License

Creative Commons License: Attribution-NonCommercial-ShareAlike 4.0 International

Acknowledgements

The authors acknowledge the facilities and scientific and technical assistance of the National Imaging Facility, a National Collaborative Research Infrastructure Strategy (NCRIS) capability.

Project details


Download files

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

Source Distribution

frametree-0.12.0.tar.gz (96.3 kB view hashes)

Uploaded Source

Built Distribution

frametree-0.12.0-py3-none-any.whl (124.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page