Mapped QC analysis program
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.settings
Configuration
Help
Templates
net/sourceforge/iharder/base64
test
uk/ac/babraham/BamQC
.gitignore
.project
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
INSTALL.md
ISSUE_TEMPLATE.md
LICENSE.txt
LICENSE_THIRD_PARTY_SOFTWARE.txt
PULL_REQUEST_TEMPLATE.md
README.md
RELEASE_NOTES.txt
bamqc
bamqc_icon.ico
build.xml
commons-lang3-3.4.jar
commons-math3-3.5.jar
hamcrest-core-1.3.jar
jbzip2-0.9.1.jar
junit-4.11.jar
log4j-1.2.16.jar
log4j.properties
run_bamqc.bat
sam-1.103.jar

README.md

BamQC

A Quality Control application for BAM files

BamQC is an application which takes a BAM file containing mapped data and runs a series of tests on it to generate a comprehensive QC report. This will help you to understand your data and will tell you if there is anything unusual the files you have analysed. Each test is flagged as a pass, warning or fail depending on how far it departs from what you'd expect from a normal large data set with no significant biases.

It's important to stress that warnings or even failures do not necessarily mean that there is a problem with your data, only that it is unusual. It is possible that the biological nature of your sample means that you would expect this particular bias in your results.

Interactive Graphical or Command Line

BamQC can be run either as an interactive graphical application which allows you to view results for multiple files in a single application. Alternatively you can run the program in a non interactive way (say as part of a pipeline) which will generate an HTML report for each file you process.

Cross-platform Java

BamQC is a cross-platform application, written in java. In theory it should run on any platform which has a suitable java runtime environment. It is been tested on Windows, MacOSX 10.6 and Linux running Java v1.6, v1.7 and v1.8.

##Download Check out of GitHub and using git:

git clone https://github.com/s-andrews/BamQC.git

Compile

To compile the source code of BamQC, a Java Compiler (JDK v1.6, v1.7, v1.8, https://www.java.com/en/download/) and the package Ant (https://ant.apache.org/) are required. The correct installation of these two packages can be tested by typing the commands:

# Test for the Java Compiler 
javac -version
# Example of output: 
# > javac 1.7.0_85

# Test for Ant
ant
# Example of output if no build.xml is located in the same folder
# > Buildfile: build.xml does not exist!
# > Build failed

BamQC can be easily built using the following commands:

# Move to the folder of BamQC
cd Path/To/BamQC/SourceCode/

# Type the command "ant". This will automatically process 
# the BamQC file build.xml 
ant

# Move to the bin folder which was created in the previous step.
cd bin

# Change permission to the file bamqc in order to execute it
chmod 755 bamqc

# Test 
./bamqc

Installation

Further instructions for installing and running the program can be found in the installation instructions file in the BamQC distribution.

Comments

If you have any comments about BamQC we would like to hear them. You can either enter them as a new issue on github.

Or email them directly to: simon.andrews at babraham.ac.uk