Skip to main content

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

Project description

FrameTree

CI/CD Codecov Python versions Latest Version Docs

Logo Small

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. Derivatives 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 for backends

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

    python3 -m pip install frametree-xnat frametree-bids

See the extension template to get started with support for different backends

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.13.5.tar.gz (101.5 kB view details)

Uploaded Source

Built Distribution

frametree-0.13.5-py3-none-any.whl (129.3 kB view details)

Uploaded Python 3

File details

Details for the file frametree-0.13.5.tar.gz.

File metadata

  • Download URL: frametree-0.13.5.tar.gz
  • Upload date:
  • Size: 101.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for frametree-0.13.5.tar.gz
Algorithm Hash digest
SHA256 4a0be52098989d4313f6a655d7808e13a8cc0b29338552630460244175a7c435
MD5 ac4e39bb415c1fa919da96492402c3df
BLAKE2b-256 19c1d25b27f3356bc963e8d788e3c36c19a43696c188fcf70d991501bc183d7d

See more details on using hashes here.

File details

Details for the file frametree-0.13.5-py3-none-any.whl.

File metadata

  • Download URL: frametree-0.13.5-py3-none-any.whl
  • Upload date:
  • Size: 129.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for frametree-0.13.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7d3eff9a4e4a26f6cdbca3c92e3183fad221f10dc22c6033b90d33770b668389
MD5 c2573e107608c5a0b0d17bd9eaeb43f7
BLAKE2b-256 c6c38817ef83ea9583c62e3cd8a269ac8968bbffa7cd6a347cf8ca05aafbd7ad

See more details on using hashes here.

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