Package to interact with lymphatic progression data and models.

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics
Maintainers
Avatar for noemibuehrer from gravatar.com noemibuehrer Avatar for YoelPH from gravatar.com YoelPH

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Roman Ludwig
  • Tags scripts , lymph , inference
  • Requires: Python >=3.10
  • Provides-Extra: docs , tests , dev
Classifiers
Report project as malware

Project description

social card

MIT license GitHub repo build badge docs badge tests badge Coverage badge

What are these lyscripts?

This package provides convenient scripts for performing inference and learning regarding the lymphatic spread of head & neck cancer. Essentially, it provides a command line interface (CLI) to the lymph library and the lydata repository that stores lymphatic progression data.

We are making these "convenience" scripts public, because doing so is one necessary requirement to making our research easily and fully reproducible. There exists another repository, lynference, where we stored the pipelines that produced our published results in a persistent way.

Installation

These scripts can be installed via pip:

pip install lyscripts

or installed from source by cloning this repo

git clone https://github.com/lycosystem/lyscripts.git
cd lyscripts
pip install .

Usage

This package is intended to be mainly used as a collection of Python scripts that would be scattered throughout my projects, if I didn't bundle them here. Hence, they're mostly command line tools that do basic and repetitive stuff.

As a Command Line Tool

Simply run

lyscripts --help

in your terminal to display the help text for the main command. It will list all subcommands that are avialable, which you can then also call with lyscripts <subcommand> --help to get more information on its use and the available arguments.

For example, one subcommand is lyscripts data collect, which will launch a small web server that allows a user to enter patient records on lymphatic involvement in head and neck cancer one row at a time and construct a standardized CSV file from it.

You can also refer to the documentation for a written-down version of all these help texts and even more context on how and why to use the provided commands.

As a Library

Head over to the documentation for more information on the individual modules, classes, and functions that are implemented in this package.

Configuration YAML Schema

Most of the CLI commands allow passing a list of --configs in the form of YAML files. If for a particular CLI argument no value is passed directly, the program looks for the corresponding value in the merged YAML files (if multiple files are provided, later ones may overwrite earlier ones).

For these YAML files we provide a unified schema containing all possible fields that any of the CLIs may accept. It is located at schemas/ly.json in this repository. So, one could configure e.g. VS Code to consider this schema for all *.ly.yaml files. Here is how that could look like in the JSON settings of VS Code:

{
    "yaml.schemas": {
        "https://raw.githubusercontent.com/lycosystem/lyscripts/main/schemas/ly.json": "*.ly.yaml"
    }
}

Subsequently, all files ending in .ly.yaml will have helpful autocompletion on the allowed/expected types available.

Project details

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics
Maintainers
Avatar for noemibuehrer from gravatar.com noemibuehrer Avatar for YoelPH from gravatar.com YoelPH

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Roman Ludwig
  • Tags scripts , lymph , inference
  • Requires: Python >=3.10
  • Provides-Extra: docs , tests , dev
Classifiers

Release history Release notifications | RSS feed

This version

1.0.2

1.0.1

1.0.0

1.0.0rc3 pre-release

1.0.0rc2 pre-release

1.0.0rc1 pre-release

1.0.0a7 pre-release

1.0.0a6 pre-release

1.0.0a5 pre-release

1.0.0a4 pre-release

1.0.0a3 pre-release

1.0.0a2 pre-release

1.0.0a1 pre-release

1.0.0a0 pre-release

0.7.3

0.7.2

0.7.1

0.7.0

0.6.9

0.6.8

0.6.7

0.6.6

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0

0.5.11

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

Download files

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

Source Distribution

lyscripts-1.0.2.tar.gz (481.8 kB view details)

Uploaded Source

Built Distribution

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

lyscripts-1.0.2-py3-none-any.whl (68.6 kB view details)

Uploaded Python 3

File details

Details for the file lyscripts-1.0.2.tar.gz.

File metadata

  • Download URL: lyscripts-1.0.2.tar.gz
  • Upload date:
  • Size: 481.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lyscripts-1.0.2.tar.gz
Algorithm Hash digest
SHA256 b4d41243567475817eb2813f643839bcb64ee5428c8c787ba4ec0b25e81e9f1a
MD5 28c67d11da7565d20f900988d531b035
BLAKE2b-256 d99b2f9cc1474ce92894065d2bf84ca9c2c9e990514e71d28256920618baa484

See more details on using hashes here.

Provenance

The following attestation bundles were made for lyscripts-1.0.2.tar.gz:

Publisher: release.yml on lycosystem/lyscripts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lyscripts-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: lyscripts-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 68.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for lyscripts-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d87324c665df0824883701f9afac3fcbd89d9f93c660eb4d539d68531d86fafe
MD5 680f6f214eebe229d290ab10fbbae2e6
BLAKE2b-256 05c8c0a098d49067feaa44d4eae4e39be0cea5a3102f284398af08a9519c6f8b

See more details on using hashes here.

Provenance

The following attestation bundles were made for lyscripts-1.0.2-py3-none-any.whl:

Publisher: release.yml on lycosystem/lyscripts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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