Skip to content

Commit

Permalink
Correct versioning information in modules
Browse files Browse the repository at this point in the history
  • Loading branch information
DLBPointon committed Dec 9, 2024
1 parent c6a2199 commit 55756f1
Show file tree
Hide file tree
Showing 5 changed files with 69 additions and 7 deletions.
62 changes: 62 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,68 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## [[1.1.0](https://github.com/sanger-tol/curationpretext/releases/tag/1.1.0)] - UNSC Delphi - [2024-12-09]

### Added

- Added map_order so that the output maps are defaulted to unsorted and can be selected as sorted.
- Updating all modules.
- Removing Anaconda 'defaults' channel.
- Updating local module containers.
- Update to LISCENSES and CITATIONS files.
- Update algorithms at play for memory allocation, particulary minimap2.
- Parity update to TreeVal as the mapping subworkflow is based on the treeval implementation.

### Paramters

| Old Version | New Versions |
| - | --map_order |

### Software Dependencies

Note, since the pipeline is using Nextflow DSL2, each process will be run with its own Biocontainer. This means that on occasion it is entirely possible for the pipeline to be using different versions of the same tool. However, the overall software dependency changes compared to the last release have been listed below for reference.

| Module | Old Version | New Versions |
| ------------------------------------------------------------------- | -------------- | -------------- |
| get_avcov | - | 1.0.0 |
| bamtobed_sort ( bedtools + samtools ) | 2.31.0 + 1.17 | 2.31.1 + 1.17 |
| bedtools ( all modules) | 2.31.1 | - |
| bwamem2 index | - | 2.2.1 |
| cram_filter_align_bwamem2_fixmate_sort | - | |
| ^ ( samtools + bwamem2 ) ^ | 1.17 + 2.2.1 | - |
| cram_filter_minimap2_filter5end_fixmate_sort | - | |
| custom_dumpsoftwareversions | - | Python 3.11.7 + yaml 5.4.1 |
| ^ ( samtools + minimap2 ) ^ | 1.17 + 2.24 | - |
| extract_cov_id ( coreutils ) | 9.1 | 9.3 |
| extract_repeat ( perl ) | 5.26.2 | - |
| extract_telo ( coreutils ) | - | 9.1 |
| find_telomere_regions ( gcc ) | 7.1.0 | 7.1.0 + 1.0 |
| find_telomere_windows ( java-jdk ) | 8.0.112 | 8.0.112 + 1.0 |
| findhalfcoverage ( python ) | - | 3.9.1 + 1.0 |
| gap_length ( coreutils ) | 9.1 | 9.3 |
| generate_cram_csv ( samtools ) | 1.17 | - |
| get_largest_scaff ( coreutils ) | 9.1 | - |
| getminmaxpunches ( coreutils ) | 9.1 | - |
| graphoverallcoverage ( perl ) | - | 5.26.2 + 1.0 |
| gnu-sort | 8.25 | 9.3 |
| longreadcoveragescalelog | - | Python 3.9.1 + 1.0 |
| minimap2 + samtools (align, map) | | 2.28-r1209 + 1.20
| pretextmap + samtools | 0.1.9 + 1.18 | 0.1.9\* + 1.20 |
| pretextgraph |0.0.4 | 0.0.6 |
| pretextsnapshot + UCSC | 0.0.6b + 447 | 0.0.4 (official version) |
| rename_ids ( coreutils ) | - | 9.1 |
| replace_dots ( coreutils ) | - | 9.1 |
| seqtk | 1.4 | 1.4-r122 |
| samtools (faidx,merge,sort,view) | 1.18 | 1.21 |
| ucsc | 445 | 469 |
| windowmasker (blast) | 2.14.0 + 1.0.0 | - |

Even modules which have not had a version bump have indeed been updated through NF-core to remove defaults.

Some modules now have two verions, the new addition is the script version rather than just the dependency version.


## [[1.0.0](https://github.com/sanger-tol/curationpretext/releases/tag/1.0.0)] - UNSC Cradle - [2024-02-22]

### Added
Expand Down
1 change: 1 addition & 0 deletions bin/get_avgcov.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
# into bed format for use
# -------------------
# Author = yy5
# Modified = dp24
# -------------------
version='1.0.0'
if [ $1 == '-v' ];
Expand Down
4 changes: 2 additions & 2 deletions modules/local/extract_repeat.nf
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ process EXTRACT_REPEAT {
cat <<-END_VERSIONS > versions.yml
"${task.process}":
perl: \$(echo \$(perl --version 2>&1) | awk '/This/ {print \$9}') | tr -d ())
perl: \$(echo \$(perl --version 2>&1) | awk '/This/ {print \$9}'))
extract_repeat.pl: $VERSION
END_VERSIONS
"""
Expand All @@ -38,7 +38,7 @@ process EXTRACT_REPEAT {
cat <<-END_VERSIONS > versions.yml
"${task.process}":
perl: \$(echo \$(perl --version 2>&1) | awk '/This/ {print \$9}') | tr -d ())
perl: \$(echo \$(perl --version 2>&1) | awk '/This/ {print \$9}'))
extract_repeat.pl: $VERSION
END_VERSIONS
"""
Expand Down
4 changes: 2 additions & 2 deletions modules/local/find_telomere_regions.nf
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ process FIND_TELOMERE_REGIONS {
cat <<-END_VERSIONS > versions.yml
"${task.process}":
find_telomere: \$(find_telomere -v)
find_telomere: \$(VERSION)
END_VERSIONS
"""

Expand All @@ -42,7 +42,7 @@ process FIND_TELOMERE_REGIONS {
cat <<-END_VERSIONS > versions.yml
"${task.process}":
find_telomere: \$(find_telomere -v)
find_telomere: \$(VERSION)
END_VERSIONS
"""

Expand Down
5 changes: 2 additions & 3 deletions modules/local/graphoverallcoverage.nf
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ process GRAPHOVERALLCOVERAGE {
cat <<-END_VERSIONS > versions.yml
"${task.process}":
perl: \$(echo \$(perl --version 2>&1) | sed 's/^.*perl //; s/Using.*\$//')
perl: \$(echo \$(perl --version 2>&1) | awk '/This/ {print \$9}'))
graph_overall_coverage.pl: \$(graph_overall_coverage.pl --version)
END_VERSIONS
"""
Expand All @@ -37,8 +37,7 @@ process GRAPHOVERALLCOVERAGE {
cat <<-END_VERSIONS > versions.yml
"${task.process}":
perl: \$(echo \$(perl --version 2>&1) | sed 's/^.*perl //; s/Using.*\$//')
graph_overall_coverage.pl: \$(graph_overall_coverage.pl --version)
perl: \$(echo \$(perl --version 2>&1) | awk '/This/ {print \$9}')) graph_overall_coverage.pl: \$(graph_overall_coverage.pl --version)
END_VERSIONS
"""
}

0 comments on commit 55756f1

Please sign in to comment.