Skip to content

Latest commit

 

History

History
163 lines (117 loc) · 9.52 KB

README.md

File metadata and controls

163 lines (117 loc) · 9.52 KB
Raw

Your Image Alt Text

WORC v3.6.3

Workflow for Optimal Radiomics Classification

Information

Unit test Documentation PyPi Citing WORC

Introduction

WORC is an open-source python package for the easy execution and fully automatic construction and optimization of radiomics workflows. For more details, we refer to the WORC paper: https://doi.org/10.48550/arXiv.2108.08618.

Overview

We aim to establish a general radiomics platform supporting easy integration of other tools. With our modular build and support of different software languages (python, MATLAB, ruby, java etc.), we want to facilitate and stimulate collaboration, standardisation and comparison of different radiomics approaches. By combining this in a single framework, we hope to find a universal radiomics strategy that can address various problems.

License

This package is covered by the open source APACHE 2.0 License.

When using WORC, please cite both this repository and the paper describing WORC as follows:

@article{starmans2021reproducible,
   title          = {Reproducible radiomics through automated machine learning validated on twelve clinical applications}, 
   author         = {Martijn P. A. Starmans and Sebastian R. van der Voort and Thomas Phil and Milea J. M. Timbergen and Melissa Vos and Guillaume A. Padmos and Wouter Kessels and David    Hanff and Dirk J. Grunhagen and Cornelis Verhoef and Stefan Sleijfer and Martin J. van den Bent and Marion Smits and Roy S. Dwarkasing and Christopher J. Els and Federico Fiduzi and Geert J. L. H. van Leenders and Anela Blazevic and Johannes Hofland and Tessa Brabander and Renza A. H. van Gils and Gaston J. H. Franssen and Richard A. Feelders and Wouter W. de Herder and Florian E. Buisman and Francois E. J. A. Willemssen and Bas Groot Koerkamp and Lindsay Angus and Astrid A. M. van der Veldt and Ana Rajicic and Arlette E. Odink and Mitchell Deen and Jose M. Castillo T. and Jifke Veenland and Ivo Schoots and Michel Renckens and Michail Doukas and Rob A. de Man and Jan N. M. IJzermans and Razvan L. Miclea and Peter B. Vermeulen and Esther E. Bron and Maarten G. Thomeer and Jacob J. Visser and Wiro J. Niessen and Stefan Klein},
   year           = {2021},
   eprint         = {2108.08618},
   archivePrefix  = {arXiv},
   primaryClass   = {eess.IV}
}

@software{starmans2018worc,
  author       = {Martijn P. A. Starmans and Thomas Phil and Sebastian R. van der Voort and Stefan Klein},
  title        = {Workflow for Optimal Radiomics Classification (WORC)},
  year         = {2018},
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.3840534},
  url          = {https://github.com/MStarmans91/WORC}
}

For the DOI, visit .

Disclaimer

This package is still under development. We try to thoroughly test and evaluate every new build and function, but bugs can off course still occur. Please contact us through the channels below if you find any and we will try to fix them as soon as possible, or create an issue on this Github.

Tutorial, documentation and dataset

The WORC tutorial is hosted at https://github.com/MStarmans91/WORCTutorial.

The official documentation can be found at https://worc.readthedocs.io.

I've developed WORC during my PhD, you can find the thesis revolving around it here: http://hdl.handle.net/1765/137089.

The publicly released WORC database is described in the following paper:

@article {Starmans2021WORCDatabase,
	author = {Starmans, Martijn P.A. and Timbergen, Milea J.M. and Vos, Melissa and Padmos, Guillaume A. and Gr{\"u}nhagen, Dirk J. and Verhoef, Cornelis and Sleijfer, Stefan and van Leenders, Geert J.L.H. and Buisman, Florian E. and Willemssen, Francois E.J.A. and Koerkamp, Bas Groot and Angus, Lindsay and van der Veldt, Astrid A.M. and Rajicic, Ana and Odink, Arlette E. and Renckens, Michel and Doukas, Michail and de Man, Rob A. and IJzermans, Jan N.M. and Miclea, Razvan L. and Vermeulen, Peter B. and Thomeer, Maarten G. and Visser, Jacob J. and Niessen, Wiro J. and Klein, Stefan},
	title = {The WORC database: MRI and CT scans, segmentations, and clinical labels for 930 patients from six radiomics studies},
	elocation-id = {2021.08.19.21262238},
	year = {2021},
	doi = {10.1101/2021.08.19.21262238},
	URL = {https://www.medrxiv.org/content/early/2021/08/25/2021.08.19.21262238},
	eprint = {https://www.medrxiv.org/content/early/2021/08/25/2021.08.19.21262238.full.pdf},
	journal = {medRxiv}
}

The code to download the WORC database and reproduce our experiments can be found at https://github.com/MStarmans91/WORCDatabase.

If you run into any issues, feel free to make an issue on this Github. We advise you to read the FAQ first though: https://worc.readthedocs.io/en/latest/static/faq.html.

Installation

NOTE: Yes, we by default run a very old version of Python and some old package versions (e.g., sklearn 0.23) due to hardware constraints. We have however already prepared a release which runs under Python 3.11 and more recent packages, which you could alternatively use: https://github.com/MStarmans91/WORC/tree/newpython. While not all features are fully tested, the default experimental setups work.

WORC supports Unix and Windows systems with Python 3.6 and 3.7: the unit tests are performed on the latest Ubuntu and Windows versions with Python 3.7. For detailed installation instructions, please check the ReadTheDocs installation guidelines.

The package can be installed through pip:

  pip install WORC

Alternatively, you can directly install WORC from this repository:

  python setup.py install

Make sure you install the requirements first:

  pip install -r requirements.txt

3rd-party packages used in WORC:

See for other python packages the requirements file.

Start

We suggest you start with the WORC Tutorial. Besides a Jupyter notebook with instructions, we provide there also an example script for you to get started with.

Contact

We are happy to help you with any questions. Please sent us a mail or place an issue on the Github.

We welcome contributions to WORC. For the moment, converting your toolbox into a FASTR tool is satisfactory: see also the fastr tool development documentation.

Optional extra features

Besides the default installation, there are several optional packages you could install to support WORC.

Graphviz

WORC can draw the network and save it as a SVG image using graphviz. In order to do so, please make sure you install graphviz. On Ubuntu, simply run

  apt install graphiv

On Windows, follow the installation instructions provided on the graphviz website. Make sure you add the executable to the PATH when prompted.

Elastix

Image registration is included in WORC through elastix and transformix. In order to use elastix, please download the binaries and place them in your fastr.config.mounts['apps'] path. Check the elastix tool description for the correct subdirectory structure. For example, on Linux, the binaries and libraries should be in "../apps/elastix/4.8/install/" and "../apps/elastix/4.8/install/lib" respectively.

Note: optionally, you can tell WORC to copy the metadata from the image file to the segmentation file before applying the deformation field. This requires ITK and ITKTools: see the ITKTools github for installation instructions.

XNAT

We use the XNATpy package to connect the toolbox to the XNAT online database platforms. You will only need this when you use the example dataset we provided, or if you want to download or upload data from or to XNAT. We advise you to specify your account settings in a .netrc file when using this feature for your own datasets, such that you do not need to input them on every request.