Code Monkey home page Code Monkey logo

tumorcnv's Introduction

TumorCNV

Introduction

TumorCNV is a tool designed to jointly detecting of germline and somatic copy number events from WGS data of the matched tumor-normal sample pair.

Installation

The easiest way to get TumorCNV is to download the binary distribution from the TumorCNV github release page. Alternatively, you can build TumorCNV from source with gradle.

  1. git clone --recursive https://github.com/yongzhuang/TumorCNV.git
  2. Install gradle build tool (https://gradle.org/)
  3. cd TumorCNV
  4. gradle build

You'll find the executable jar file in TumorCNV/build/libs/.

If you want to run TumorCNV, you'll need:

  1. Install Java SE Development Kit 8
  2. Install R (Rscript exectuable must be on the path)
  3. Install Runiversal (https://cran.r-project.org/web/packages/Runiversal/index.html), VGAM (https://cran.r-project.org/web/packages/VGAM/index.html) and qcc(https://cran.r-project.org/web/packages/qcc/) package in R

Running

usage: java -jar TumorCNV.jar [OPTIONS]

1. preprocess

This option is used to extract the information from the normal and tumor BAM files.

usage: java -jar TumorCNV.jar preprocess [OPTIONS]

-referenceSequenceFile reference genome file (required)
-normalVCFFile normal sample's vcf file (optional)
-normalBAMFile normal sample's bam file (required)
-tumorBAMFile tumor sample's bam file (required)
-mappabilityFile mappability file (required)
-outputPrefix prefix of output file (required)
-windowSize window size (optional, default 500)
-minMappingQuality minimum mapping quality (optional, default 1)
-minBaseQuality minimum base quality (optional, default 20)

2. call

This option is used to jointly call germline and soamtic CNVs.

usage: java -jar TumorCNV.jar call [OPTIONS]

-rdFile read depth file (required)
-afFile allele frequency file (optional)
-mappabilityFile mappability file (required)
-outputFile prefix of toutput file (required)
-exclude exclude regions
-transitionProb transition probability of different states (optional, default 0.00001)
-minMappability minimum mappability of window (optional, default 0.3)
-minDisatance minimum distance to merge adjacent CNVs (optional, default 10000)
-purity tumor purity (optional, default 1.0)
-ploidy tumor ploidy (optional, default 2)
-outlier the percentage of outliers (optional, default 0.1)
-nt number of threads (optional, default 1)

Example

The sample data sets and script can be found at http://182.92.97.240/exchange/190419/example.zip, and the users need to download the reference genome file (ftp://ftp-trace.ncbi.nih.gov/1000genomes/ftp/technical/reference/phase2_reference_assembly_sequence/hs37d5.fa.gz) and mappability file (http://hgdownload.cse.ucsc.edu/goldenpath/hg19/encodeDCC/wgEncodeMapability/wgEncodeCrgMapabilityAlign100mer.bigWig).

Contact

[email protected]

License

MIT

tumorcnv's People

Contributors

yongzhuang avatar

Stargazers

 avatar

Watchers

 avatar

tumorcnv's Issues

Cannot find TumorCNV.java in TumorCNV/build

After running gradle build, there is no 'libs' directory in build, only 'classes' in it. Besides, there no error was reported. I find a "TumorCNV.java" in src directory, however it did not work well (Error: Invalid or corrupt jarfile TumorCNV.java) even it run 'chmod 777 TumorCNV.java' to make it executable.

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.