Skip to content

Commit 39eb040

Browse files
GallVpGallVp
authored
Merge pull request #185 from Plant-Food-Research-Open/patch/184
Patched 183,184,179,178 for 2.2.1
2 parents 0141925 + 0439cbf commit 39eb040

File tree

22 files changed

+159
-99
lines changed

22 files changed

+159
-99
lines changed

‎.nf-core.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,5 +46,5 @@ template:
4646
- igenomes
4747
- multiqc
4848
- fastqc
49-
version: 2.2.0dev
49+
version: 2.2.1
5050
update: null

‎CHANGELOG.md

+19
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,25 @@
33
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
44
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
55

6+
## v2.2.1 - [11-Dec-2024]
7+
8+
### `Added`
9+
10+
1. Added notes on HTTP(s) server on the HiC page and on the need to move dynamically loaded content when moving the report's HTML file [#183](https://github.com/Plant-Food-Research-Open/assemblyqc/issues/183)
11+
12+
### `Fixed`
13+
14+
1. Fixed an issue where PLOTSR crashed due to a mismatch in the ordering of `syri.out` files when `synteny_plotsr_assembly_order` was not specified [#184](https://github.com/Plant-Food-Research-Open/assemblyqc/issues/184)
15+
2. Fixed an issue where a path to HiC FastQ file pairs from the current directory were considered a SRR ID [#179](https://github.com/Plant-Food-Research-Open/assemblyqc/issues/179)
16+
3. Fixed edges and input/output arrows in the flowchart [#178](https://github.com/Plant-Food-Research-Open/assemblyqc/issues/178)
17+
18+
### `Dependencies`
19+
20+
1. Nextflow!>=24.04.2
21+
2. [email protected]
22+
23+
### `Deprecated`
24+
625
## v2.2.0 - [05-Nov-2024]
726

827
### `Added`

‎CITATION.cff

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ authors:
2525
- family-names: "Deng"
2626
given-names: "Cecilia"
2727
title: "AssemblyQC: A Nextflow pipeline for reproducible reporting of assembly quality"
28-
version: 2.2.0
28+
version: 2.2.1
2929
date-released: 2024-07-30
3030
url: "https://github.com/Plant-Food-Research-Open/assemblyqc"
3131
doi: 10.1093/bioinformatics/btae477

‎bin/report_modules/parsers/synteny_parser.py

+5-2
Original file line numberDiff line numberDiff line change
@@ -147,9 +147,12 @@ def parse_synteny_plotsr(folder_name="synteny_outputs"):
147147
"error_message": (
148148
None
149149
if error_comparisons == []
150-
else "<b>Note:</b> Syri failed to detect structural rearrangements for following comparisons: "
150+
else '<b style="color: red;">Error:</b> Syri failed to detect structural rearrangements for following comparisons: '
151151
+ ", ".join(
152-
[f"{target} with reference to {ref}" for (target, ref) in error_comparisons]
152+
[
153+
f"{target} with reference to {ref}"
154+
for (target, ref) in error_comparisons
155+
]
153156
)
154157
+ '. This may be due to known Syri limitations. See: <a href="https://github.com/schneebergerlab/syri/tree/ebd0f832e0df33398306f1b65f86801090c1ed49#current-limitations" target="_blank">GitHub/Syri/Limitations</a>'
155158
),

‎bin/report_modules/templates/header.html

+1
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,7 @@
136136
width: 90%;
137137
min-width: 700px;
138138
margin: auto;
139+
padding-bottom: 16px;
139140
}
140141

141142
.dropdown select {

‎bin/report_modules/templates/hic/hic.html

+25-6
Original file line numberDiff line numberDiff line change
@@ -8,38 +8,57 @@
88
<p class="section-para"><b>References:</b></p>
99

1010
<p class="section-para">
11-
<b>fastp</b> Chen, Yanqing Zhou, Yaru Chen, Jia Gu, fastp: an ultra-fast all-in-one FASTQ preprocessor, Bioinformatics,
11+
<b>fastp</b> Chen, Yanqing Zhou, Yaru Chen, Jia Gu, fastp: an ultra-fast all-in-one FASTQ preprocessor,
12+
Bioinformatics,
1213
Volume 34, Issue 17, September 2018, Pages i884–i890, <a href="https://doi.org/10.1093/bioinformatics/bty560"
1314
target="_blank">10.1093/bioinformatics/bty560</a>
1415
</p>
1516

1617
<p class="section-para">
17-
<b>BWA</b> Li, H. (2013). Aligning sequence reads, clone sequences and assembly contigs with BWA-MEM. arXiv preprint <a
18-
href="https://arxiv.org/abs/1303.3997" target="_blank">arXiv: 1303.3997</a>.
18+
<b>BWA</b> Li, H. (2013). Aligning sequence reads, clone sequences and assembly contigs with BWA-MEM. arXiv
19+
preprint <a href="https://arxiv.org/abs/1303.3997" target="_blank">arXiv: 1303.3997</a>.
1920
</p>
2021

2122
<p class="section-para">
22-
<b>SAMBLASTER</b> Gregory G. Faust, Ira M. Hall, SAMBLASTER: fast duplicate marking and structural variant read extraction,
23+
<b>SAMBLASTER</b> Gregory G. Faust, Ira M. Hall, SAMBLASTER: fast duplicate marking and structural variant read
24+
extraction,
2325
Bioinformatics, Volume 30, Issue 17, September 2014, Pages 2503–2505, <a
2426
href="https://doi.org/10.1093/bioinformatics/btu314" target="_blank">10.1093/bioinformatics/btu314</a>
2527
</p>
2628

2729
<p class="section-para">
28-
<b>SAMtools</b> Petr Danecek, James K Bonfield, Jennifer Liddle, John Marshall, Valeriu Ohan, Martin O Pollard, Andrew Whitwham,
30+
<b>SAMtools</b> Petr Danecek, James K Bonfield, Jennifer Liddle, John Marshall, Valeriu Ohan, Martin O Pollard,
31+
Andrew Whitwham,
2932
Thomas Keane, Shane A McCarthy, Robert M Davies, Heng Li, Twelve years of SAMtools and BCFtools, GigaScience,
3033
Volume
3134
10, Issue 2, February 2021, giab008, <a href="https://doi.org/10.1093/gigascience/giab008"
3235
target="_blank">10.1093/gigascience/giab008</a>
3336
</p>
3437

3538
<p class="section-para">
36-
<b>Juicebox.js</b> Robinson JT, Turner D, Durand NC, Thorvaldsdóttir H, Mesirov JP, Aiden EL. Juicebox.js Provides a
39+
<b>Juicebox.js</b> Robinson JT, Turner D, Durand NC, Thorvaldsdóttir H, Mesirov JP, Aiden EL. Juicebox.js Provides
40+
a
3741
Cloud-Based Visualization System for Hi-C Data. Cell Syst. 2018 Feb 28;6(2):256-258.e1.
3842
<a href="https://doi.org/10.1016/j.cels.2018.01.001" target="_blank">10.1016/j.cels.2018.01.001</a>. Epub
3943
2018 Feb 7. PMID: 29428417; PMCID: PMC6047755.
4044
</p>
4145

4246
<p class="section-para"><b>Version: {{ all_stats_dicts['VERSIONS']['JUICEBOX_JS'] }}</b></p>
47+
48+
<p class="section-para"><b>Notes:</b></p>
49+
<ul>
50+
<li>
51+
The Hi-C contact map is only loaded when the report is opened through a HTTP(s) server and all the necessary
52+
permissions are in place. The contact map '.hic' file is stored in the 'hic' folder under the output directory.
53+
It can be visualized with <a href="https://github.com/aidenlab/Juicebox/wiki/Download">Juicebox</a>.
54+
</li>
55+
<li>
56+
This report dynamically loads content from the 'hic' folder under the output directory including '*.hic',
57+
'*.html', 'bedpe/' and 'hicqc/'. These files and folders should also be moved when moving the report's HTML
58+
file.
59+
</li>
60+
</ul>
4361
</div>
62+
4463
{% include 'hic/dropdown.html' %} {% include 'hic/report_contents.html' %}
4564
</div>

‎bin/report_modules/templates/kraken2/kraken2.html

+17-12
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
<div id="KRAKEN2" class="tabcontent" style="display: none">
2-
<div class="section-para-wrapper">
3-
<p class="section-para">
4-
Kraken2 assigns taxonomic labels to sequencing reads for metagenomics projects.
5-
</p>
6-
<p class="section-para"><b>Reference:</b></p>
7-
<p class="section-para">
8-
Wood, D.E., Lu, J. & Langmead, B. Improved metagenomic analysis with Kraken 2. Genome Biol 20, 257 (2019).
9-
<a href="https://doi.org/10.1186/s13059-019-1891-0" target="_blank">10.1186/s13059-019-1891-0</a>
10-
</p>
11-
<p class="section-para"><b>Version: {{ all_stats_dicts['VERSIONS']['KRAKEN2']['kraken2'] }}</b></p>
12-
</div>
13-
{% include 'kraken2/dropdown.html' %} {% include 'kraken2/report_contents.html' %}
2+
<div class="section-para-wrapper">
3+
<p class="section-para">
4+
Kraken2 assigns taxonomic labels to sequencing reads for metagenomics projects.
5+
</p>
6+
<p class="section-para"><b>Reference:</b></p>
7+
<p class="section-para">
8+
Wood, D.E., Lu, J. & Langmead, B. Improved metagenomic analysis with Kraken 2. Genome Biol 20, 257 (2019).
9+
<a href="https://doi.org/10.1186/s13059-019-1891-0" target="_blank">10.1186/s13059-019-1891-0</a>
10+
</p>
11+
<p class="section-para"><b>Version: {{ all_stats_dicts['VERSIONS']['KRAKEN2']['kraken2'] }}</b></p>
12+
13+
<p class="section-para"><b>Note:</b></p>
14+
<p class="section-para">This report dynamically loads '*.kraken2.krona.html' files from the 'kraken2' folder under
15+
the output directory. These files should also be moved when moving the report's HTML file.</p>
16+
17+
</div>
18+
{% include 'kraken2/dropdown.html' %} {% include 'kraken2/report_contents.html' %}
1419
</div>

‎bin/report_modules/templates/ncbi_fcs_gx/ncbi_fcs_gx.html

+25-21
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
11
<div id="NCBI_FCS_GX" class="tabcontent" style="display: none">
2-
<div class="section-para-wrapper">
3-
<p class="section-para">FCS-GX detects contamination from foreign organisms in genome sequences.</p>
4-
<p class="section-para"><b>Reference:</b></p>
5-
<p class="section-para">
6-
Alexander Astashyn, Eric S Tvedte, Deacon Sweeney, Victor Sapojnikov, Nathan Bouk, Victor Joukov, Eyal
7-
Mozes, Pooja K Strope, Pape M Sylla, Lukas Wagner, Shelby L Bidwell, Karen Clark, Emily W Davis, Brian
8-
Smith-White, Wratko Hlavina, Kim D Pruitt, Valerie A Schneider, Terence D Murphy bioRxiv 2023.06.02.543519;
9-
doi:
10-
<a href="https://doi.org/10.1101/2023.06.02.543519" target="_blank">10.1101/2023.06.02.543519</a>, GitHub:
11-
<a href="https://github.com/ncbi/fcs" target="_blank">https://github.com/ncbi/fcs</a>
12-
</p>
13-
<p class="section-para">
14-
<b>Version: {{ all_stats_dicts['VERSIONS']['NCBI_FCS_GX_SCREEN_SAMPLES']['fcs_gx'] }}</b>
15-
</p>
16-
<p class="section-para">
17-
<b>DB Version: {{ all_stats_dicts['NCBI_FCS_GX'][0]['report_meta_data'][1]['db']['build-date'] }}</b>
18-
</p>
19-
</div>
20-
{% include 'ncbi_fcs_gx/dropdown.html' %}
21-
{% include 'ncbi_fcs_gx/summary_contents.html' %}
22-
{% include 'ncbi_fcs_gx/report_contents.html' %}
2+
<div class="section-para-wrapper">
3+
<p class="section-para">FCS-GX detects contamination from foreign organisms in genome sequences.</p>
4+
<p class="section-para"><b>Reference:</b></p>
5+
<p class="section-para">
6+
Alexander Astashyn, Eric S Tvedte, Deacon Sweeney, Victor Sapojnikov, Nathan Bouk, Victor Joukov, Eyal
7+
Mozes, Pooja K Strope, Pape M Sylla, Lukas Wagner, Shelby L Bidwell, Karen Clark, Emily W Davis, Brian
8+
Smith-White, Wratko Hlavina, Kim D Pruitt, Valerie A Schneider, Terence D Murphy bioRxiv 2023.06.02.543519;
9+
doi:
10+
<a href="https://doi.org/10.1101/2023.06.02.543519" target="_blank">10.1101/2023.06.02.543519</a>, GitHub:
11+
<a href="https://github.com/ncbi/fcs" target="_blank">https://github.com/ncbi/fcs</a>
12+
</p>
13+
<p class="section-para">
14+
<b>Version: {{ all_stats_dicts['VERSIONS']['NCBI_FCS_GX_SCREEN_SAMPLES']['fcs_gx'] }}</b>
15+
</p>
16+
<p class="section-para">
17+
<b>DB Version: {{ all_stats_dicts['NCBI_FCS_GX'][0]['report_meta_data'][1]['db']['build-date'] }}</b>
18+
</p>
19+
20+
<p class="section-para"><b>Note:</b></p>
21+
<p class="section-para">This report dynamically loads '*.fcs.gx.krona.html' files from the 'ncbi_fcs_gx' folder under the output
22+
directory. These files should also be moved when moving the report's HTML file.</p>
23+
</div>
24+
{% include 'ncbi_fcs_gx/dropdown.html' %}
25+
{% include 'ncbi_fcs_gx/summary_contents.html' %}
26+
{% include 'ncbi_fcs_gx/report_contents.html' %}
2327
</div>

‎bin/report_modules/templates/synteny_circos/synteny_circos.html

+40-37
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
11
<div id="SYNTENY_CIRCOS" class="tabcontent" style="display: none">
2-
<div class="section-para-wrapper">
3-
<p class="section-para">
4-
Circos facilitates the identification and analysis of similarities and differences arising from comparisons
5-
of genomes. The genome-wide alignments are performed with MUMMER.
6-
</p>
7-
<p class="section-para"><b>References:</b></p>
8-
<p class="section-para">
9-
Krzywinski, M., Schein, J., Birol, I., Connors, J., Gascoyne, R., Horsman, D., ... & Marra, M. A. (2009).
10-
Circos: an information aesthetic for comparative genomics. Genome research, 19(9), 1639-1645.
11-
<a href="https://doi.org/10.1101/gr.092759.109" target="_blank">10.1101/gr.092759.109</a>
12-
</p>
13-
<p class="section-para">
14-
Marçais G, Delcher AL, Phillippy AM, Coston R, Salzberg SL, Zimin A. MUMmer4: A fast and versatile genome
15-
alignment system. PLoS Comput Biol. 2018 Jan 26;14(1):e1005944.
16-
<a href="https://doi.org/10.1371/journal.pcbi.1005944" target="_blank">10.1371/journal.pcbi.1005944</a>
17-
</p>
18-
<p class="section-para">
19-
<b
20-
>Versions: {{ all_stats_dicts['VERSIONS']['CIRCOS']['circos'] }} (CIRCOS), {{
21-
all_stats_dicts['VERSIONS']['MUMMER']['nucmer'] }} (MUMMER)</b
22-
>
23-
</p>
24-
<p class="section-para"><b>Notes:</b></p>
25-
<ul>
26-
<li>
27-
Alignments within a distance of {{ all_stats_dicts['PARAMS_DICT']['synteny_mummer_max_gap'] }}bp have been
28-
bundled together.
29-
</li>
30-
<li>
31-
After bundling, any bundle smaller than {{ all_stats_dicts['PARAMS_DICT']['synteny_mummer_min_bundle_size'] }}bp has been filtered out.
32-
</li>
33-
<li>
34-
The sequence labels shown on the plot are based on the labelling file provided to the pipeline. These labels may or may not be same as the sequence IDs in the corresponding FASTA files.
35-
</li>
36-
</ul>
37-
</div>
38-
{% include 'synteny_circos/dropdown.html' %} {% include 'synteny_circos/report_contents.html' %}
2+
<div class="section-para-wrapper">
3+
<p class="section-para">
4+
Circos facilitates the identification and analysis of similarities and differences arising from comparisons
5+
of genomes. The genome-wide alignments are performed with MUMMER.
6+
</p>
7+
<p class="section-para"><b>References:</b></p>
8+
<p class="section-para">
9+
Krzywinski, M., Schein, J., Birol, I., Connors, J., Gascoyne, R., Horsman, D., ... & Marra, M. A. (2009).
10+
Circos: an information aesthetic for comparative genomics. Genome research, 19(9), 1639-1645.
11+
<a href="https://doi.org/10.1101/gr.092759.109" target="_blank">10.1101/gr.092759.109</a>
12+
</p>
13+
<p class="section-para">
14+
Marçais G, Delcher AL, Phillippy AM, Coston R, Salzberg SL, Zimin A. MUMmer4: A fast and versatile genome
15+
alignment system. PLoS Comput Biol. 2018 Jan 26;14(1):e1005944.
16+
<a href="https://doi.org/10.1371/journal.pcbi.1005944" target="_blank">10.1371/journal.pcbi.1005944</a>
17+
</p>
18+
<p class="section-para">
19+
<b>Versions: {{ all_stats_dicts['VERSIONS']['CIRCOS']['circos'] }} (CIRCOS), {{
20+
all_stats_dicts['VERSIONS']['MUMMER']['nucmer'] }} (MUMMER)</b>
21+
</p>
22+
23+
<p class="section-para"><b>Notes:</b></p>
24+
<ul>
25+
<li>
26+
Alignments within a distance of {{ all_stats_dicts['PARAMS_DICT']['synteny_mummer_max_gap'] }}bp have been
27+
bundled together.
28+
</li>
29+
<li>
30+
After bundling, any bundle smaller than {{ all_stats_dicts['PARAMS_DICT']['synteny_mummer_min_bundle_size'] }}bp
31+
has been filtered out.
32+
</li>
33+
<li>
34+
The sequence labels shown on the plot are based on the labelling file provided to the pipeline. These labels may
35+
or may not be same as the sequence IDs in the corresponding FASTA files.
36+
</li>
37+
</ul>
38+
39+
</div>
40+
41+
{% include 'synteny_circos/dropdown.html' %} {% include 'synteny_circos/report_contents.html' %}
3942
</div>

‎bin/report_modules/templates/synteny_dotplot/synteny_dotplot.html

+4-1
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,16 @@
1010
<p class="section-para">
1111
<b>Version: {{ all_stats_dicts['VERSIONS']['MUMMER']['nucmer'] }} (MUMMER)</b>
1212
</p>
13+
1314
<p class="section-para"><b>Notes:</b></p>
1415
<ul>
1516
<li>
1617
Alignments within a distance of {{ all_stats_dicts['PARAMS_DICT']['synteny_mummer_max_gap'] }}bp have been
1718
bundled together.
1819
</li>
1920
<li>
20-
After bundling, any bundle smaller than {{ all_stats_dicts['PARAMS_DICT']['synteny_mummer_min_bundle_size'] }}bp has
21+
After bundling, any bundle smaller than {{ all_stats_dicts['PARAMS_DICT']['synteny_mummer_min_bundle_size'] }}bp
22+
has
2123
been filtered out.
2224
</li>
2325
<li>
@@ -26,5 +28,6 @@
2628
</li>
2729
</ul>
2830
</div>
31+
2932
{% include 'synteny_dotplot/dropdown.html' %} {% include 'synteny_dotplot/report_contents.html' %}
3033
</div>

‎bin/report_modules/templates/synteny_plotsr/synteny_plotsr.html

+5
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,11 @@
3131
all_stats_dicts['VERSIONS']['SYRI']['syri'] }} (SYRI), {{
3232
all_stats_dicts['VERSIONS']['MINIMAP2_ALIGN']['minimap2'] }} (MINIMAP2)</b>
3333
</p>
34+
35+
<p class="section-para"><b>Note:</b></p>
36+
<p>This report dynamically loads '*.on.*.all/' folders from the 'synteny' folder under the output directory. These
37+
folders should also be moved when moving the report's HTML file.</p>
38+
3439
</div>
3540
{% include 'synteny_plotsr/report_contents.html' %}
3641
</div>

‎docs/images/assemblyqc.png

8.78 KB
Loading

‎nextflow.config

+1-1
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ manifest {
274274
description = """A Nextflow pipeline which evaluates assembly quality with multiple QC tools and presents the results in a unified html report."""
275275
mainScript = 'main.nf'
276276
nextflowVersion = '!>=24.04.2'
277-
version = '2.2.0'
277+
version = '2.2.1'
278278
doi = 'https://doi.org/10.1093/bioinformatics/btae477'
279279
}
280280

‎subworkflows/local/fasta_synteny.nf

+1-1
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ workflow FASTA_SYNTENY {
344344
| map { meta, syri, fastas ->
345345
def fasta_list = fastas.flatten()
346346
def syri_tags = syri.collect { it.name.replace('syri.out', '').split(/\.on\./).toList() }.flatten().unique()
347-
def proposed_order = plotsr_assembly_order ? plotsr_assembly_order.tokenize(' ') : syri_tags.sort(false)
347+
def proposed_order = plotsr_assembly_order ? plotsr_assembly_order.tokenize(' ') : syri_tags.sort(false) { it.toUpperCase() }
348348

349349
def available_tags = []
350350
proposed_order.each { tag -> if ( tag in syri_tags ) available_tags << tag }

0 commit comments

Comments
 (0)