Skip to main content

A package for evaluating RECIST criteria from CSV files

Project description

pyrecist

A Python package for computing RECIST 1.1 assessments from lesion measurements stored in tabular format.

Instalation

To install the package, run the following command in your terminal:

pip install pyrecist

Features

  • RECIST classification for each follow-up study based exclusively on target lesions.
  • Evaluations are performed in chronological order based on study dates, assuming the first study is the baseline and all others are follow-ups.
  • Once Progressive Disease (PD) is reached, subsequent classifications are marked as None.
  • Supports input in CSV format.
  • Not yet supported:
    • Appearance of new lesions.
    • Evaluation of non-target lesions.

Usage

The CLI script takes a .csv file containing RECIST measurements and generates an output .csv file with the corresponding classifications for each follow-up.

For example, to evaluate the measurements on example.csv and save the results to /home/example_user, run:

pyrecist example.csv -o /home/example_user

You can test the package using the synthetic measurements available in the tests/data directory.

Input format

The input should be a CSV file where each row represents a RECIST measurement taken from a study. The following five columns are required:

Column header Type Description Example
patient_id Integer Pseudonymized identifier of the patient 1
study_date String Date of the study in the format YYYYMMDD 20190220
measurement Float RECIST measurement in mm 15.43
lesion_label_alias String Letter used as an alias to identify a lesion within a patient A
lesion_category String Lesion category (target, non-target) target

Run pyrecist -h to see how to customize the name of the expected column headers. For example, if your CSV file contain the measurements in a column called recist_measurements, then you can run:

pyrecist example.csv -o /home/example_user --measurement_header recist_measurements

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

pyrecist-0.1.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

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

pyrecist-0.1.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file pyrecist-0.1.0.tar.gz.

File metadata

  • Download URL: pyrecist-0.1.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for pyrecist-0.1.0.tar.gz
Algorithm Hash digest
SHA256 83e6dc51e7dac384f0149b91dce2d6351c1b70db37a95f6c011d6de0ccaba2ae
MD5 89917f703b9484e45a5fca0986ed3201
BLAKE2b-256 85e275be22f398b5540e27228578e5f8941b8ed0277c1c4443d3c57e93309ffc

See more details on using hashes here.

File details

Details for the file pyrecist-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyrecist-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for pyrecist-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f01c29ecb636f31b0a23490c25f18b31f4710aa6153802c5ae35ca59bda71870
MD5 b7c89ec35f310b9eb6f216e64a5d78f8
BLAKE2b-256 5f28aff532401911e45973e3a6957589fa4b93c171d248ec8d95ca2596aaeb02

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