<commit_before># AscatNGS

| Master                                        | Develop                                         |
| --------------------------------------------- | ----------------------------------------------- |
| [![Master Badge][travis-master]][travis-base] | [![Develop Badge][travis-develop]][travis-base] |

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][ascat-web]_**.

For details of the underlying algorithm please see the [ASCAT][ascat-web] site.  The GitHub
repository can be found [here][ascat-gh].

Contents:

<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->

- [ASCAT core algorithm](#ascat-core-algorithm)
- [Docker, Singularity and Dockstore](#docker-singularity-and-dockstore)
- [Dependencies/Install](#dependenciesinstall)
	- [Reference files](#reference-files)
- [Creating a release](#creating-a-release)
	- [Preparation](#preparation)
	- [Cutting the release](#cutting-the-release)
- [LICENCE](#licence)

<!-- /TOC -->

## ASCAT core algorithm

The core `ascat.R` script is pulled from the primary ASCAT repository during intallation.  The linked version is currently [`v2.4.3`][ascat-release].

## Docker, Singularity and Dockstore

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

* [dockstore-cgpwgs][ds-cgpwgs-git]: Contains additional tools for WGS analysis.

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:

* [PCAP-core v2.0+][pcap-core-rel]
  * `ascatNgs` has other dependancies fulfilled by `PCAP-core`.
* [cgpVcf v2.0+][cgpvcf-rel]
* [alleleCount v3.0+][allelecount-rel]

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.

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

### Reference files

Please see the [wiki][ascatngs-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.
1. Update `CHANGES.md` with key updates.
1. Run `./prerelease.sh`
1. Check all tests and coverage reports are acceptable.
1. Commit the updated docs tree and updated module/version.
1. Push commits.
1. Use the GitHub tools to draft a release.

## LICENCE

```
Copyright (c) 2014-2018 Genome Research Ltd.

Author: CASM/Cancer IT <<EMAIL>>

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/>.
```

<!-- Travis -->
[travis-base]: https://travis-ci.org/cancerit/ascatNgs
[travis-master]: https://travis-ci.org/cancerit/ascatNgs.svg?branch=master
[travis-develop]: https://travis-ci.org/cancerit/ascatNgs.svg?branch=dev

<!-- refs -->
[allelecount-rel]: https://github.com/cancerit/alleleCount/releases
[cgpvcf-rel]: https://github.com/cancerit/cgpVcf/releases
[pcap-core-rel]: https://github.com/cancerit/PCAP-core/releases
[ascat-web]: https://www.crick.ac.uk/peter-van-loo/software/ASCAT
[ascat-gh]: https://github.com/Crick-CancerGenomics/ascat
[ascat-release]: https://github.com/Crick-CancerGenomics/ascat/releases/tag/v2.4.3
[ascatngs-wiki]: https://github.com/cancerit/ascatNgs/wiki
[ds-cgpwgs-git]: https://github.com/cancerit/dockstore-cgpwgs
<commit_msg>Correct version of ASCAT.R in doc<commit_after># AscatNGS

| Master                                        | Develop                                         |
| --------------------------------------------- | ----------------------------------------------- |
| [![Master Badge][travis-master]][travis-base] | [![Develop Badge][travis-develop]][travis-base] |

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][ascat-web]_**.

For details of the underlying algorithm please see the [ASCAT][ascat-web] site.  The GitHub
repository can be found [here][ascat-gh].

Contents:

<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->

- [ASCAT core algorithm](#ascat-core-algorithm)
- [Docker, Singularity and Dockstore](#docker-singularity-and-dockstore)
- [Dependencies/Install](#dependenciesinstall)
	- [Reference files](#reference-files)
- [Creating a release](#creating-a-release)
	- [Preparation](#preparation)
	- [Cutting the release](#cutting-the-release)
- [LICENCE](#licence)

<!-- /TOC -->

## ASCAT core algorithm

The core `ascat.R` script is pulled from the primary ASCAT repository during intallation.  The linked version is currently [`v2.5`][ascat-release].

## Docker, Singularity and Dockstore

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

* [dockstore-cgpwgs][ds-cgpwgs-git]: Contains additional tools for WGS analysis.

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:

* [PCAP-core v2.0+][pcap-core-rel]
  * `ascatNgs` has other dependancies fulfilled by `PCAP-core`.
* [cgpVcf v2.0+][cgpvcf-rel]
* [alleleCount v3.0+][allelecount-rel]

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.

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

### Reference files

Please see the [wiki][ascatngs-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.
1. Update `CHANGES.md` with key updates.
1. Run `./prerelease.sh`
1. Check all tests and coverage reports are acceptable.
1. Commit the updated docs tree and updated module/version.
1. Push commits.
1. Use the GitHub tools to draft a release.

## LICENCE

```
Copyright (c) 2014-2018 Genome Research Ltd.

Author: CASM/Cancer IT <<EMAIL>>

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/>.
```

<!-- Travis -->
[travis-base]: https://travis-ci.org/cancerit/ascatNgs
[travis-master]: https://travis-ci.org/cancerit/ascatNgs.svg?branch=master
[travis-develop]: https://travis-ci.org/cancerit/ascatNgs.svg?branch=dev

<!-- refs -->
[allelecount-rel]: https://github.com/cancerit/alleleCount/releases
[cgpvcf-rel]: https://github.com/cancerit/cgpVcf/releases
[pcap-core-rel]: https://github.com/cancerit/PCAP-core/releases
[ascat-web]: https://www.crick.ac.uk/peter-van-loo/software/ASCAT
[ascat-gh]: https://github.com/Crick-CancerGenomics/ascat
[ascat-release]: https://github.com/Crick-CancerGenomics/ascat/releases/tag/v2.5
[ascatngs-wiki]: https://github.com/cancerit/ascatNgs/wiki
[ds-cgpwgs-git]: https://github.com/cancerit/dockstore-cgpwgs

{'fraction_non_alphanumeric': 0.12951334379905807, 'fraction_numerical': 0.00717649697241534, 'mean_word_length': 3.726550079491256, 'pattern_counts': {'":': 0, '<': 17, '<?xml version=': 0, '>': 17, 'https://': 22, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 10, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4450197', 'n_tokens_mistral': 2851, 'n_tokens_neox': 2676, 'n_words': 917}