Skip to content

Latest commit

 

History

History
140 lines (98 loc) · 4.97 KB

README.md

File metadata and controls

140 lines (98 loc) · 4.97 KB
Raw

AscatNGS

Master Develop
Master Badge Develop Badge

AscatNGS contains the Cancer Genome Projects workflow implementation of the ASCAT copy number algorithm for paired end sequencing.

We do not offer support for WXS analysis, please contact the authors of ASCAT here.

For details of the underlying algorithm please see the ASCAT site. The GitHub repository can be found here.

Contents:

ASCAT core algorithm

The core ascat.R script is pulled from the primary ASCAT repository during installation. The linked version is currently v2.5.1.

Minimum sequence depth

The minimum depth that you are likely to get reliable results from is 15x genome coverage. If you have very good quality data with good insert size (little or no overlap of reads) you may be successful with 12x.

Docker, Singularity and Dockstore

There is a pre-built image containing this codebase on quay.io.

This was primarily designed for use with dockstore.org but can be used as normal containers.

The docker images are know to work correctly after import into a singularity image.

Dependencies/Install

Please install the following first:

Please see these for any child dependencies.

Once complete please run:

./setup.sh /some/install/location

If you are installing each tool (PCAP-code, cgpVcf, alleleCount) to an independent area you should set the environment variable CGP_PERLLIBS to include the relevant perl libraries from those, e.g.

export CGP_PERLLIBS=/pcapInst/libs/perl5:/cgpvcfInst/libs/perl5:...

Please be aware that this software requires the Rscript executable to be pre-installed.

Reference files

Please see the wiki for how to obtain/generate the SnpGcCorrections.tsv file.

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 perl/lib/Sanger/CGP/Ascat.pm to the correct version.
  2. Update CHANGES.md with key updates.
  3. Run ./prerelease.sh
  4. Check all tests and coverage reports are acceptable.
  5. Commit the updated docs tree and updated module/version.
  6. Push commits.
  7. Use the GitHub tools to draft a release.

LICENCE

Copyright (c) 2014-2020 Genome Research Ltd.

Author: CASM/Cancer IT <[email protected]>

This file is part of AscatNGS.

AscatNGS is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation; either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.