Code Monkey home page Code Monkey logo

marginphase's Introduction

MarginPhase

MarginPhase is a program for simultaneous haplotyping and genotyping.

Dependencies

cmake version 3.7 (or higher):

wget https://cmake.org/files/v3.7/cmake-3.7.2-Linux-x86_64.sh && mkdir /opt/cmake && sh cmake-3.7.2-Linux-x86_64.sh --prefix=/opt/cmake --skip-license && ln -s /opt/cmake/bin/cmake /usr/local/bin/cmake

If you're on Ubuntu:

apt-get -y install git make gcc g++ autoconf bzip2 lzma-dev zlib1g-dev libcurl4-openssl-dev libcrypto++-dev libpthread-stubs0-dev libbz2-dev liblzma-dev
  • Check out the repository:
git clone [email protected]:benedictpaten/marginPhase.git
  • Check out submodules:
cd marginPhase
git submodule update --init
  • Make build directory:
mkdir build
cd build
  • Generate Makefile with cmake:
cmake ..
  • Build with make:
make

Running the program

  • to run marginPhase: marginPhase <BAM_FILE> <REFERENCE_FASTA> <PARAMS> [options]

  • program OPTIONS:

Required arguments:
    BAM is the alignment of reads.  All reads must be aligned to the same contig 
        and be in bam format.
    REFERENCE_FASTA is the reference sequence for the BAM's contig in fasta format.
    PARAMS is the file with marginPhase parameters.


Default options:
    -h --help              : Print this help screen
    -o --outputBase        : Base output identifier [default = "output"]
                               "example" -> "example.sam", "example.vcf"
    -a --logLevel          : Set the log level [default = info]
    -t --tag               : Annotate all output reads with this value for the 
                               'mp' tag

Nucleotide probabilities options:
    -s --singleNuclProbDir : Directory of single nucleotide probabilities files
    -S --onlySNP           : Use only single nucleotide probabilities information,
                               so reads that aren't in SNP dir are discarded

VCF Comparison options:
    -r --referenceVCF      : Reference vcf file for output comparison
    -v --verbose           : Bitmask controlling outputs 
                                 1 - LOG_TRUE_POSITIVES
                                 2 - LOG_FALSE_POSITIVES
                                 4 - LOG_FALSE_NEGATIVES
                               example: 0 -> N/A; 2 -> LFP; 7 -> LTP,LFP,LFN)
  • Nucleotide Probabilities - this is an alternate input format where reads aligned in a bam have nucleotide alignment posteriors stored in an external location. This option expects the files to be of the form: ${singleNuclProbDir}/${readId}.tsv If specified, MarginPhase will load the posteriors into its model instead of alignments taken directly from the BAM. Experimentally, we have found that alignments in this form help ameliorate high error rates found in long reads.

  • VCF Comparison - passing in a referenceVCF into the program will do a comparison of the generated VCF and the specified truth set. Verbosity level will determine what variant classifications will be printed.

  • to run tests: ./allTests (This runs every test. You can comment out ones you don't want to run in allTests.c)

Notes:

  • you'll need to have a reference genome available to write out all the files

marginphase's People

Contributors

tpesout avatar mhaukness avatar benedictpaten avatar

Watchers

James Cloos 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.