lyscripts 1.0.0a1

Package containing scripts used in lynference pipelines

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.

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 store the pipelines that produce(d) our published results in a persistent way. Head over there to learn more about how to reproduce our work.

Installation

These scripts can be installed via pip:

pip install lyscripts

or installed from source by cloning this repo

git clone https://github.com/rmnldwg/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 and let the output guide you through the functions of the program.

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.