Skip to content

Commit

Permalink
Merge branch 'release/3.6.0'
Browse files Browse the repository at this point in the history
- Addition of `FF019` and `FF020` flags
- New flag rule set `pulldownFfpeRulesFragment.lst` including FF019 and FF020 made
  • Loading branch information
Thomas Clarke committed Dec 13, 2021
2 parents b5ba69c + b6c6603 commit 1080166
Show file tree
Hide file tree
Showing 42 changed files with 1,758 additions and 592 deletions.
16 changes: 16 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@

version: 2.1
jobs:
license_chk:
machine:
# need machine as want to mount a volume
image: ubuntu-2004:202107-02
steps:
- checkout
- run:
name: Execute skywalking-eyes check of licenses
command: |
docker run --rm -v $(pwd):/github/workspace apache/skywalking-eyes header check
build:
environment:
IMAGE_NAME: quay.io/wtsicgp/cgppindel
Expand Down Expand Up @@ -55,7 +65,13 @@ workflows:
version: 2.1
build_test:
jobs:
- license_chk:
filters:
tags:
only: /.+/
- build:
requires:
- license_chk
context:
- dockerhub-casmservice
- quayio-casmservice
Expand Down
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/issue-bug-question.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,17 @@
---
______________________________________________________________________

name: Issue/Bug/Question
about: Includes checks
title: ''
labels: ''
assignees: ''

---
______________________________________________________________________

Please ensure that you have check the following before raising a new issue:

* [README](https://github.com/cancerit/cgpPindel/blob/dev/README.md)
* [Wiki](https://github.com/cancerit/cgpPindel/wiki)
* Existing issues (closed too) before raising a new item
- [README](https://github.com/cancerit/cgpPindel/blob/dev/README.md)
- [Wiki](https://github.com/cancerit/cgpPindel/wiki)
- Existing issues (closed too) before raising a new item

Please provide as much information as possible.
93 changes: 93 additions & 0 deletions .licenserc.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
header:
license:
spdx-id: AGPL-3.0-or-later
copyright-owner: Genome Research Ltd
content: |
Copyright (c) 2014-2021 Genome Research Ltd
Author: CASM/Cancer IT <[email protected]>
This file is part of cgpPindel.
This program 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 <https://www.gnu.org/licenses/>.
1. The usage of a range of years within a copyright statement contained within
this distribution should be interpreted as being equivalent to a list of years
including the first and last year specified and all consecutive years between
them. For example, a copyright statement that reads ‘Copyright (c) 2005, 2007-
2009, 2011-2012’ should be interpreted as being identical to a statement that
reads ‘Copyright (c) 2005, 2007, 2008, 2009, 2011, 2012’ and a copyright
statement that reads ‘Copyright (c) 2005-2012’ should be interpreted as being
identical to a statement that reads ‘Copyright (c) 2005, 2006, 2007, 2008,
2009, 2010, 2011, 2012’.
pattern: |
Copyright \(c\) [-0-9]+ .+
Author: .+
This file is part of .+
This program 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.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
1. The usage of a range of years within a copyright statement contained within
this distribution should be interpreted as being equivalent to a list of years
including the first and last year specified and all consecutive years between
them. For example, a copyright statement that reads ‘Copyright \(c\) 2005, 2007-
2009, 2011-2012’ should be interpreted as being identical to a statement that
reads ‘Copyright \(c\) 2005, 2007, 2008, 2009, 2011, 2012’ and a copyright
statement that reads ‘Copyright \(c\) 2005-2012’ should be interpreted as being
identical to a statement that reads ‘Copyright \(c\) 2005, 2006, 2007, 2008,
2009, 2010, 2011, 2012’.
paths:
- '**'

paths-ignore:
- '.circleci'
- '.coveragerc'
- '.dockerignore'
- '.gitignore'
- '.pre-commit-config.yaml'
- 'CHANGES.md'
- 'Dockerfile'
- 'LICENSE'
- 'pyproject.toml'
- 'README.md'
- '**/*.yaml'
- 'tests/data/**/*'
- '**/*.egg-info/PKG-INFO'
- '.pytest_cache/'
- 'build/'
- 'MANIFEST.in'
- 'tests/htmlcov/'
- '.eggs/'
- 'c++/*.cpp' # not ours, distributed via agreement
- 'perl/t/'
- 'perl/rules/'
- 'perl/pm_to_blib'
- 'perl/blib/'
- 'perl/MANIFEST*'
- 'perl/MYMETA*'
- '.github/'
- 'INSTALL'
- 'Makefile'

comment: on-failure
27 changes: 27 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.0.1
hooks:
- id: check-added-large-files
args: ['--maxkb=3000']
- id: check-ast
- id: check-executables-have-shebangs
- id: check-shebang-scripts-are-executable
- id: check-merge-conflict
- id: check-toml
- id: check-yaml
- id: detect-aws-credentials
args: [--allow-missing-credentials]
- id: detect-private-key
- id: end-of-file-fixer
- id: name-tests-test
- id: requirements-txt-fixer
- id: trailing-whitespace
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.6
hooks:
- id: mdformat
- repo: https://github.com/hadolint/hadolint
rev: v2.4.1
hooks:
- id: hadolint-docker
97 changes: 54 additions & 43 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,103 +1,109 @@
# CHANGES

## 3.6.0
- Addition of `FF019` and `FF020` flags
- New flag rule set `pulldownFfpeRulesFragment.lst` including FF019 and FF020 made

## 3.5.0

- Update to core pindel algorithm to allow complex DI events to have longer inserted sequence than deleted
- Masking real events

## 3.4.1

* Updated Dockerfile to use pcap-core 5.4.0 - htslib/samtools 1.11
- Updated Dockerfile to use pcap-core 5.4.0 - htslib/samtools 1.11

## 3.4.0

* Updated Dockerfile to use pcap-core 5.2.2
* Modified setup script to use build/*.sh
- Updated Dockerfile to use pcap-core 5.2.2
- Modified setup script to use build/\*.sh

## 3.3.0

* I/O hardening, see [milestone 3](https://github.com/cancerit/cgpPindel/milestone/3)
- I/O hardening, see [milestone 3](https://github.com/cancerit/cgpPindel/milestone/3)

## 3.2.2

* Handle Input files that may have no reads at all, specifically an issue when generating a normal panel.
- Handle Input files that may have no reads at all, specifically an issue when generating a normal panel.

## 3.2.1

* Added Dockerfile and docker documentation
- Added Dockerfile and docker documentation

## 3.2.0

* Tabix search for high depth/excluded regions now performed in memory using IntervalTrees
* Reduces runtime of input step by ~50%
* Improved disk access profile
* Zero impact on results
- Tabix search for high depth/excluded regions now performed in memory using IntervalTrees
- Reduces runtime of input step by ~50%
- Improved disk access profile
- Zero impact on results

## 3.1.2

* 3.0.5 introduced species parsing bug causing single word species names to be invalid.
- 3.0.5 introduced species parsing bug causing single word species names to be invalid.

## 3.1.1

* Fix regression - ability to cope with chromosomes with no events.
- Fix regression - ability to cope with chromosomes with no events.

## 3.1.0

* Incorporates updated pindel which improves sensitivity
* Internally interpret QCFAIL to determine if whole pair fails
- Incorporates updated pindel which improves sensitivity
- Internally interpret QCFAIL to determine if whole pair fails

## 3.0.6

* Fixed version tag
- Fixed version tag

## 3.0.5

* Handles species names with spaces in it
* modified checks for species,assembly and checksum
- Handles species names with spaces in it
- modified checks for species,assembly and checksum

## 3.0.4

* Output bug for pindel BAM/CRAM corrected. When more than 1 chr in output files had no reads.
- Output bug for pindel BAM/CRAM corrected. When more than 1 chr in output files had no reads.

## 3.0.3

* Changes to how germline filter determined resulted in dummy germline bed file not being generated as previously.
* This release reinstates the old behaviour.
- Changes to how germline filter determined resulted in dummy germline bed file not being generated as previously.
- This release reinstates the old behaviour.

## 3.0.2

* Correct example rule files for *Fragment.lst files to use FFnnn filter types
- Correct example rule files for \*Fragment.lst files to use FFnnn filter types

## 3.0.1

* Update tabix calls to directly use query_full (solves GRCh38 contig name issues).
- Update tabix calls to directly use query_full (solves GRCh38 contig name issues).

## 3.0.0

* Germline bed file is now merged for adjacent regions (#31)
* More compressed intermediate files (#55)
* Change to `Const::Fast` where appropriate (#41)
* Removed TG VG from genotype.
* Readgroups are always variable, often 1 in data from last few years
* Not used by our filters.
* Supports BAM/CRAM inputs
* Output will be aligned with inputs
* bam vs cram
* bai vs csi
* Although ground work for csi input/output has been done `Bio::DB::HTS` doesn't support csi indexed input yet.
* Created our own fork at [`cancerit/Bio::DB::HTS`][cancerit-biodbhts] so that this could be enabled.
* You will need to install this manually or use one of our images for this functionallity.
* [dockstore-cgpwxs][ds-cgpwxs-git]
* [dockstore-cgpwxs][ds-cgpwgs-git]
- Germline bed file is now merged for adjacent regions (#31)
- More compressed intermediate files (#55)
- Change to `Const::Fast` where appropriate (#41)
- Removed TG VG from genotype.
- Readgroups are always variable, often 1 in data from last few years
- Not used by our filters.
- Supports BAM/CRAM inputs
- Output will be aligned with inputs
- bam vs cram
- bai vs csi
- Although ground work for csi input/output has been done `Bio::DB::HTS` doesn't support csi indexed input yet.
- Created our own fork at [`cancerit/Bio::DB::HTS`][cancerit-biodbhts] so that this could be enabled.
- You will need to install this manually or use one of our images for this functionallity.
- [dockstore-cgpwxs][ds-cgpwxs-git]
- [dockstore-cgpwxs][ds-cgpwgs-git]

<!-- -->
[cancerit-biodbhts]: https://github.com/cancerit/Bio-DB-HTS/releases/tag/v2.10-rc1
[ds-cgpwxs-git]: https://github.com/cancerit/dockstore-cgpwxs
[ds-cgpwgs-git]: https://github.com/cancerit/dockstore-cgpwgs

## 2.2.5

* Update tabix->query to tabix->query_full
- Update tabix->query to tabix->query_full

## 2.2.4

* Force sorting of FILTER field to make records easier to diff.
* Fix sorting of final VCF to handle events with same start better when using comparison tools
- Force sorting of FILTER field to make records easier to diff.
- Fix sorting of final VCF to handle events with same start better when using comparison tools

## 2.2.3

Expand Down Expand Up @@ -175,3 +181,8 @@ Found 15321 SNPs common to both files.
Found 0 SNPs only in main file.
Found 0 SNPs only in second file.
After
```

[cancerit-biodbhts]: https://github.com/cancerit/Bio-DB-HTS/releases/tag/v2.10-rc1
[ds-cgpwgs-git]: https://github.com/cancerit/dockstore-cgpwgs
[ds-cgpwxs-git]: https://github.com/cancerit/dockstore-cgpwxs
Loading

0 comments on commit 1080166

Please sign in to comment.