/PCAP-core

NGS reference implementations and helper code for mapping (originally part of ICGC-TCGA-PanCancer)

Primary LanguagePerlGNU General Public License v2.0GPL-2.0

PCAP-core

NGS reference implementations and helper code for mapping and mapping related stats.

This has been forked from the ICGC-TCGA-PanCancer/PCAP-core repository as this codebase was created by cancerit and continues to be developed. This version strips out PCAWG related elements and incorporates more efficient code.

Master Dev
Build Status Build Status

This repository contains code to run genomic alignments of paired end data and subsequent calling algorithms.

The intention is to provide reference implementations and simple to execute wrappers that are useful for the scientific community who may have little IT/bioinformatic support.

Please see the wiki for further details.

###Dependencies/Install

Please install the following before running setup.sh:

Dependancies installed by setup.sh:

And various perl modules.

Please see the respective licence for each before use.

Please be aware that this expects basic C compilation libraries and tools to be available, most are listed in INSTALL.

###Programs

Please see the wiki for details of programs.

##Creating a release ####Preparation

  • Commit/push all relevant changes.
  • Pull a clean version of the repo and use this for the following steps.

####Cutting the release

  1. Update lib/PCAP.pm to the correct version.
  2. Ensure upgrade path for new version number is added to lib/PCAP.pm.
  3. Update CHANGES.md to show major items.
  4. Run ./prerelease.sh
  5. Check all tests and coverage reports are acceptable.
  6. Commit the updated docs tree and updated module/version.
  7. Push commits.
  8. Use the GitHub tools to draft a release.