Skip to main content

Package for statistical modelling of lymphatic metastatic spread.

Project description

https://raw.githubusercontent.com/rmnldwg/lymph/main/docs/source/_static/github-social-card.png https://img.shields.io/badge/license-MIT-blue.svg?style=flat https://img.shields.io/badge/GitHub-rmnldwg%2Flymph-blue.svg?style=flat https://img.shields.io/badge/DOI-10.1038%2Fs41598--021--91544--1-success.svg?style=flat https://github.com/rmnldwg/lymph/actions/workflows/tests.yml/badge.svg?style=flat https://github.com/rmnldwg/lymph/actions/workflows/build.yml/badge.svg?style=flat https://codecov.io/gh/rmnldwg/lymph/branch/main/graph/badge.svg?token=LPXQPK5K78 https://readthedocs.org/projects/lymph-model/badge

A Python package for statistical modelling of lymphatic metastatic spread in head & neck squamous cell carinoma (HNSCC).

Motivation

HNSCC spreads though the lymphatic system of the neck and forms metastases in regional lymph nodes. Macroscopic metastases can be detected with imaging modalities like MRI, PET and CT scans. They are then consequently included in the target volume, when radiotherapy is chosen as part of the treatment. However, microscopic metastases are too small be diagnosed with current imaging techniques.

To account for this microscopic involvement, parts of the lymphatic system are often irradiated electively to increase tumor control. Which parts are included in this elective clinical target volume is currently decided based on guidelines [1] [2] [3] [4]. These in turn are derived from reports of the prevalence of involvement per lymph node level (LNL), i.e. the portion of patients that were diagnosed with metastases in any given LNL, stratified by primary tumor location. It is recommended to include a LNL in the elective target volume if 10 - 15% of patients showed involvement in that particular level.

However, while the prevalence of involvement has been reported in the literature [5] [6], and the general lymph drainage pathways are understood well, the detailed progression patterns of HNSCC remain poorly quantified. We believe that the risk for microscopic involvement in an LNL depends highly on the specific diagnosis of a particular patient and their treatment can hence be personalized if the progression patterns were better quantified.

Our Goal

With this Python package we want to provide a framework to accurately predict the risk for microscopic metastases in any lymph node level for the specific diagnosis a particular patient presents with.

The implemented model is highly interpretable and was developed together with clinicians to accurately represent the anatomy of the lymphatic drainiage. It can be trained with data that reports the patterns of lymphatic progression in detail, like the dataset(s) we collected at our institution, the University Hospital Zurich (USZ).

The mathematical details of the models can be found in in our earlier publications [7] [8].

Get started

To learn how to use this package, head over to our documentation where we explain the API of the package and also provide a quickstart guide.

The implementation is pure-python and has only a few dependencies. However, it is intended to be used with powerful inference algorithms, e.g. the great sampling package emcee, which we used for our results.

Attribution

If you use this code in you work you may either attribute use by citing our paper [8] or by using the CITATION.cff file in this repository, which specifically cites the software.

See also

The dataset(s)

A large and detailed dataset containing the patterns of lymphatic progression of patients treated at the USZ are available in this repo on GitHub. We have also published a paper on the dataset and our interface (described below) in Radiotherapy & Oncology [9]. A preprint is available on medRxiv [10].

This data may be used to train the model.

LyProX interface

The above mentioned data can also be explored interactively using our online interface LyProX (GitHub repo).

References

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

lymph-model-1.2.0.tar.gz (189.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lymph_model-1.2.0-py3-none-any.whl (56.3 kB view details)

Uploaded Python 3

File details

Details for the file lymph-model-1.2.0.tar.gz.

File metadata

  • Download URL: lymph-model-1.2.0.tar.gz
  • Upload date:
  • Size: 189.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for lymph-model-1.2.0.tar.gz
Algorithm Hash digest
SHA256 7fe551e5b3e1187d9cc9724c62cb403a92efcd90ca78c2801558f631521df29f
MD5 8934e544cce419ae851e60c3ada780e0
BLAKE2b-256 7d6fe3b09bc727d089b7a4f9c198b62a4a8c521968f2af1d38ced9e98e1807a9

See more details on using hashes here.

File details

Details for the file lymph_model-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: lymph_model-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 56.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.14

File hashes

Hashes for lymph_model-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d88119864eb7bb49b84cda88ece239d8d4f8cb51c92b6b166f69aecea9690e42
MD5 789b8aa5ca30eca6e209bd7da57445d8
BLAKE2b-256 ae520bfac763a935ad4b6ee5614d59499e2ccf463c675904ba669c99eac7902a

See more details on using hashes here.

Supported by

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