Giter VIP home page Giter VIP logo

oral-cavity-paper's Introduction

Patterns of Lymph Node Involvement for Oral Cavity Squamous Cell Carcinoma

This repository provides the source code to reproduce all figures and table in our publication with the above title that we intend to submit to The Green Journal and update them in case the data changes. Below we provide instructions on how to achieve this.

Warning

This paper is still under review and not yet published. Content and data here are still subject to change.

Important

All software in this repository is licensed under the MIT license. However, when executed, the pipeline described here will download data that is licensed under CC BY-SA 4.0.

Reproduce the Pipeline

First, clone the repository:

git clone https://github.com/rmnldwg/oral-cavity-paper

And change your working directory to the root of the repository:

cd oral-cavity-paper

Using bash

Note

Requires bash on Linux

If you're using bash on Linux and don't want to install Docker, you may get away with simply running the repro.sh script:

bash setup.sh

It should do the following things in order:

  1. pull changes from the GitHub remote repo,
  2. automatically find your latest Python 3 installation,
  3. set up a virtual environment,
  4. install all Python packages defined in requirements.txt,
  5. download (and update) the data sources,
  6. reproduce the pipeline

But this script is probably quite platform dependent. So, if this does not work, a safer way to get the desired results is using Docker, which is explained below.

Using Docker

Note

Requires a Docker installation.

Although Docker is platform independent, it is sometimes a hassle to get it installed and running. Here is a guide to the Docker installation.

If Docker is up and running on your system, the following two commands should do the reproduction:

docker build -t ocp-image .

and then run it with the following command:

docker run \
    --rm --volume .:/usr/src/oral-cavity-paper \
    --name ocp-container \
    ocp-image

That should run the pipeline from joining the datasets to plotting the figures and tables.

oral-cavity-paper's People

Contributors

larstwi avatar rmnldwg avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.