MACH2-Viz

MACH2 is an upgraded version of MACHINA, (El-Kebir et. al.). MACH2-Viz visualizes the solution space for algorithms running the parsimonious migration history problem with polytomy resolution. Solutions are generated via MACH2 (Roddur et. al.). MACH2-Viz also supports data from MACHINA or any cancer migration history inference software as long as the data can be compiled into valid JSON format for MACH2-Viz to parse.

Current Deployed Version

To view the current deployment of MACH2Viz, go to this link

Running MACH2-Viz on Localhost

To run MACH2-Viz on localhost, simply do the following:

1. Clone this repository
2. Run npm install
3. Run npm start
   a. NOTE: You may run into dependency issues with OpenSSL
   b. in which case simply run export NODE_OPTIONS=--openssl-legacy-provider and try again

Documentation

To view documentation for using MACH2-Viz, refer to this link

Contributing

If you have a dataset that you would like to add to our gallery, follow these steps:

1. Create a fork of this repository. If you already have a fork, make sure to git pull from main.
2. Run MACH2 and get a JSON
3. Put your JSON in src/samples within your fork
4. Add an entry to src/samples/mapping.json like below.
   1. "name" and "dataset" can be arbitrarily named (but make it appropriate for the dataset).
   2. "path" must be the path to the json relative to the samples/ directory.
5. Create a pull request and we can approve it.

{
  "name": "patient_name",
  "dataset": "dataset_name",
  "path": "path"
}

For more information on contributing to this repository, see the following.