Skip to content

EESI/MetaMutationalSigs

 
 

Repository files navigation

MetaMutationalSigs

Logo

Docker Cloud Build Status Docker Image Version (latest by date) Docker Image Size (tag) Docker Pulls

Mutational signature analysis is very active and important area of interest. There are several packages available now for mutational signature analysis and they all use different approaches and give nontrivially different results. Because of the differences in their results, it is important for researchers to survey the available tools and make choose the one that best suits their application. There is a need for software that can aggregate the results from different packages and present them in a user friendly way so as to facilitate effective comparison.

We created this package MetaMutationalSigs to facilitate comprehensive mutational signature analysis by creating a wrapper for different packages and providing a standard format for their outputs so that they can be effectively compared. We have also standardized the input formats accepted by various packages so ease interoperability. We also create standard visualizations for the results of all packages to ensure easy analysis. Our software is easy to install and use through Docker ,a package manager that automates the dependencies.

See our preprint here:

If you have questions, you can contact the author, Palash Pandey at [email protected] OR PI Gail Rosen at [email protected]

Install Using Docker

docker pull pp535/metamutationalsigs

The docker image can be found at dockerhub here: https://hub.docker.com/r/pp535/metamutationalsigs

Input:

VCF files.

To run metamutationalsigs without using sigflow and sigfit on the data from your VCF file directory C:\Users\...full_path...\docker_input_test. Just replace C:\Users\...full_path...\docker_input_test/ with absolute path to your input directory that has VCF files. The results will be in a zipped file in your input directory.
docker run --rm -v C:\Users\...full_path...\docker_input_test/:/app/input_vcf_dir pp535/metamutationalsigs. All tools are run by default, if you wish to not run a tool, you can provide its name as a flag such as docker run --rm -v C:\Users\...full_path...\docker_input_test/:/app/input_vcf_dir pp535/metamutationalsigs --mutationalSignatures would run all other tools except for mutationalSignatures.

We have browser UI available as well:

docker run --rm -p 5001:5001 pp535/metamutationalsigs --browser

Just replace C:\Users\...full_path...\docker_input_test/ with absolute path to your input directory that has VCF files. Then go to your browser at http://localhost:5001/ for the browser user interface.

web_ui_1

Once you select your VCF file directory and the tools that you would like to run, you will see a progress bar and when the progress bar reaches 100%, you can download the results as a zip file using the download results button.
web_ui_2

Output:

The output is returned as a compressed directory called MetaMutationalResults. Once uncompressed, this looks below. Directory MetaMutationalResults has the relevant results.

result files

Inside MetaMutationalResults, we can find a folder for each tool that was selected. result files

Here is a summary of the files generated:

File Name Format Description
Heatmap_contributions_all_sigs_[signature_version].svg svg Contributions from all signatures of the [signature_version] to the overall signature.
Heatmap_[signature_version].svg svg Heatmap of cosine similarity between the predicted contributions by different tools for [signature_version].
[signature_version]_bar_charts.html html Bar charts of signature contributions per sample and per tool for [signature_version].
rmse_box_plot.svg svg Box plot of RMSE between the reconstructed signal (from the reference signatures) and the overall signature
[tool_name][signature_version]_sample_error.csv csv Data about the difference between reconstructed and signal for each signature of [signature_version] for each [tool_name] for each sample. This is used to create rmse_box_plot.svg
[tool_name][signature_version]_contribution.csv csv Data about the contribution of each signature of [signature_version] for each [tool_name] for each sample. This is used to create the Heatmap_contributions_all_sigs_[singature_version].svg, Heatmap_[signature_version].svg and [signature_version]_bar_charts.html.

FAQs / Resources:

Where can I find the tools used ?

Additional reading: review paper

Omichessan, H., Severi, G., & Perduca, V. (2019). Computational tools to detect signatures of mutational processes in DNA from tumours: A review and empirical comparison of performance. PLOS ONE, 14(9), e0221235. https://doi.org/10.1371/journal.pone.0221235

What reference genomes are supported?

MetamutationalSigs supports:

GRCh37/ hg19 Homo sapiens
GRCh38/ hg38 Homo sapiens
GRCm37/ mm9 Mus musculus
GRCm38.p6/ mm10 Mus musculus
Rnor_6.0/ rn6 Rattus norvegicus

What is the format for my files?

Your files need to be in VCF format. For more information https://www.internationalgenome.org/wiki/Analysis/vcf4.0/

Where is my analysis running?

All analysis is run locally. No data leaves your computer. The web browser user interface is also running locally on your computer, so you can feel free to analyze your protected data.

You can also run the analysis on Terra using the Docker image

You can use this workflow as a starting point: https://portal.firecloud.org/?return=terra#methods/MetaMutationalSigs/MetaMutationalSigs/1

Changelog

  • V1 - COSMIC reference signatures V3.1 June 2020
  • V2 - COSMIC reference signatures updated to V3.2 March 2020
  • V3* Current - Added results HTML page. Now users can see the figures before downloading them.

Issues with Docker

docker run --rm -v C:\Users\...full_path...\docker_input_test/:/app/input_vcf_dir pp535/metamutationalsigs

  • --rm means delete the container once execution is finished. This is done to free up memory after the results are extracted.
  • -v gives the path of the directory that we want to mount.

Packages

No packages published

Languages

  • HTML 38.1%
  • Python 21.4%
  • R 16.7%
  • Jupyter Notebook 16.5%
  • CSS 4.4%
  • JavaScript 1.9%
  • Dockerfile 1.0%