Releases: Plant-Food-Research-Open/assemblyqc
Releases · Plant-Food-Research-Open/assemblyqc
Version 2.2.1
What's Changed
Added
- 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
Fixed
- Fixed an issue where PLOTSR crashed due to a mismatch in the ordering of
syri.out
files whensynteny_plotsr_assembly_order
was not specified #184 - Fixed an issue where a path to HiC FastQ file pairs from the current directory were considered a SRR ID #179
- Fixed edges and input/output arrows in the flowchart #178
Dependencies
- Nextflow!>=24.04.2
- nf-schema@2.1.1
PRs
Full Changelog: 2.2.0...2.2.1
Version 2.2.0
What's Changed
Added
- Added Gfastats #126
- Updated nf-core/template to 3.0.2 #149
- Updated
samtools faidx
to 1.21 - Now using nf-test for pipeline level testing #153
- Added
text/html
as content mime type for the report file #146 - Added a sequence labels table below the HiC contact map #147
- Added parameter
hic_samtools_ext_args
and set its default value to-F 3852
#159 - Added the HiC QC report to the final report so that users don't have to navigate to the results folder #162
- Added the fastp log to the final report #163
- Updated the tube map along with the tool list #166
- Added Orthofinder #167
- Changed order of tool options in the
nextflow.config
file - Updated PFR's Kraken 2 database to
k2_pluspfp_20240904
#170 - Increased memory requirement for Kraken 2 to
256.GB
Fixed
- Fixed a bug where Gene score distribution graph did not appear correctly #125
- Increased memory requirement for
DNADIFF
to avoid SLURM OOM kills with exit code 2 #141 - Documented the use explicit use of
-revision
parameter #160 - Now using
_JAVA_OPTIONS
in moduleRUNASSEMBLYVISUALIZER
to avoid user preferences related errors
Dependencies
- Nextflow!>=24.04.2
- nf-schema@2.1.1
Deprecated
- Reduced the GenomeTools stats figures to 300 DPI #142
- Now
synteny_mummer_min_bundle_size
is set to1000000
by default #142 results
is not the default output directory anymore- Removed a number of unnecessary parameters:
monochromeLogs
,config_profile_contact
,config_profile_url
,validationFailUnrecognisedParams
,validationLenientMode
,validationSchemaIgnoreParams
,validationShowHiddenParams
validate_params
- Resource parameters have been removed:
max_memory
,max_cpus
,max_time
Full Changelog: 2.1.1...2.2.0
Version 2.1.1
What's Changed
- Made the
hic
param pattern more flexible by @GallVp in #131 - Updated modules to remove Bioconda
defaults
channel by @GallVp in #133 - Fixed flowchart syntax to remove '\n' by @GallVp in #134
- Now correctly validating gff files for circular sequences by @GallVp in #136
- Version bump to 2.1.1 by @GallVp in #137
- Formatted mermaid chart by @GallVp in #138
- Fixed the branch protection GitHub action by @GallVp in #140
- Candidate for 2.1.1 by @GallVp in #139
Full Changelog: 2.1.0...2.1.1
Version 2.1.0
What's Changed
Full Changelog: 2.0.0...2.1.0
Added
- Created summary presence/absence tables for NCBI FCS modules #88
- Added min. system requirements #91
- Added a test to verify the fix for the bug which resulted in a pipeline crash for assemblies without LTRs
- Updated NCBI FCS GX to 0.5.4 #93
- Updated
SYRI
to 1.7.0 #104 - Added a script to automatically check for updates on GitHub/GitLab and post issues
- Updated modules:
UNTAR
,MERYL_COUNT
,GUNZIP
,MINIMAP2_ALIGN
,FASTQC
Fixed
- Fixed a bug where
intron_length_distribution
was used instead ofcds_length_distribution
when creating the CDS Length Distribution Graph #95 - Fixed a bug where 'Subsequent pipeline modules are skipped.' was printed in the
report.html
even whencontamination_stops_pipeline
was set to false - Now NCBI FCS GX module uses all the cores available from the Nextflow task
- Fixed a bug which caused
PLOTSR
to fail for certain assembly names #102 - Now
LTRRETRIEVER_LTRRETRIEVER
does not crash when the input assembly does not contain any LTRs #92 - Now
LTRRETRIEVER_LTRRETRIEVER
does not crash when the input assembly is not writable #98 - Now soft masked regions are unmasked before computing LAI #117
- Fixed a bug in
ASSEMBLATHON_STATS
which caused it to fail on MMC executor due to multiple binds of thebin
directory - Changed
NextFlow
toNextflow
- Updated citation to Bioinformatics
Dependencies
- Nextflow!>=23.04.0
- nf-validation@1.1.3
Deprecated
- Changed default branch name from
master
tomain
in nf-core template files - Moved
version_check.sh
to.github/version_checks.sh
- Moved
docs/contributors.sh
to.github/contributors.sh
- Removed dependency on https://github.com/PlantandFoodResearch/nxf-modules.git
- Replaced
nf-core/fastq_trim_fastp_fastqc
withnf-core/fastq_fastqc_umitools_fastp
which has nf-test unit tests - Removed version check on README.md
Version 2.0.0
What's Changed
Full Changelog: 1.4...2.0.0
Added
- Updated nf-core/template to 2.14.1
- Removed release-announcements GitHub workflow
- Added a list of nf-core contributors
- Added a launcher script for local testing
local_assemblyqc
- Added a custom
BUNDLELINKS
module which respects direction when bundlingDNADIFF
links #82 - Added the ability to create linear synteny plot in addition to the circos plot #74
- Updated modules and sub-workflows:
BWA/INDEX
,BWA/MEM
,CAT/CAT
, ,CUSTOM/RESTOREGFFIDS
,CUSTOM/SHORTENFASTAIDS
,GT/GFF3
,GT/GFF3VALIDATOR
,GT/STAT
,LTRFINDER
,LTRHARVEST
,LTRRETRIEVER/LAI
,LTRRETRIEVER/LTRRETRIEVER
,SAMBLASTER
,FASTA_LTRRETRIEVER_LAI
,FASTQ_BWA_MEM_SAMBLASTER
,GFF3_VALIDATE
,CUSTOM/SRATOOLSNCBISETTINGS
,FASTP
,FASTQC
,UNTAR
,SEQKIT/SEQ
,SEQKIT/SORT
,FASTA_EXPLORE_SEARCH_PLOT_TIDK
- Now the
contamination_stops_pipeline
flag allows the pipeline to continue if contamination is detected. It's default value istrue
#54 - Now fasta ids are sorted in natural order for the HiC module #76
- Now using
FASTQ_DOWNLOAD_PREFETCH_FASTERQDUMP_SRATOOLS
for SRA downloads - Added
MERQURY
module #85 - Replaced
GFF3_VALIDATE
sub-workflow withGFF3_GT_GFF3_GFF3VALIDATOR_STAT
- Replaced local
BUSCO
module withFASTA_GXF_BUSCO_PLOT
sub-workflow #75 - Replaced local
NCBI_FCS_ADAPTOR
with nf-core module and updated to 0.5.0 which includes additional adaptors for PacBio and Nanopore technologies #55 - Added PLOTSR #77
- Added JADWOS01 assembly to xrefsheet for successfully running PLOTSR
- Now detecting duplicate sequences with
SEQKIT/RMDUP
#64
Fixed
- Fixed a bug which caused NCBI_FCS_GX to not resume #80
- Restored the original version of
nf-core/subworkflows/fastq_trim_fastp_fastqc
- Fixed n-core linting
- Updated
tower.yml
- Updated LICENSE copyright to Copyright (c) 2024 The New Zealand Institute for Plant and Food Research Limited #81
RUNASSEMBLYVISUALIZER
is now single threaded for successful execution on both Linux and MacOS- Fixed java memory overflow issues in
RUNASSEMBLYVISUALIZER
- Updated
FASTA_LTRRETRIEVER_LAI
to fix a pipeline crash whench_monoploid_seqs
was[ meta, [] ]
#83 - Improved input assembly documentation #86
- Added assembly tag to synteny warning message regarding missing
synteny_labels
file - Now copying files in
NCBI_FCS_GX_SETUP_SAMPLE
rather than symlinking in an attempt to support NextFlow Fusion
Dependencies
- NextFlow!>=23.04.0
- nf-validation@1.1.3
Deprecated
- Removed
CIRCOS_BUNDLELINKS
module - Now the default value of
synteny_plot_1_vs_all
is false - Replace module
CUSTOM/CHECKGFF3FASTACORRESPONDENCE
with a local groovy function inGFF3_GT_GFF3_GFF3VALIDATOR_STAT
sub-workflow
Version 1.4
What's Changed
Added
- Now it is possible to skip FASTP and FASTQC for the HIC module
- Renamed ASSEMBLY_QC workflow to ASSEMBLYQC
- Now using nf-core/FASTA_EXPLORE_SEARCH_PLOT_TIDK
- Now redirecting validation errors to AssemblyQC report
- Simplified layout of CITATIONS.md file
- Now using pfr/gff3_validate sub-workflow for gff3 validation
- Now listing software versions from the versions.yml file
- Replaced custom GUNZIP module with nf-core/gunzip
- Replaced custom gt/stat with pfr/gt/stat
- Replaced custom fasta_validator with nf-core/fastavalidator
- Added pre-commit version checking
- Now gt/stat reports extended stats and multiple distribution plots have been added to the report
- Added a tools tab to the report which lists the tools used by the pipeline to create the report
- Refactored and cleaned data flows for all the custom sub-workflow
- Started using nf-core template
- Started using semantic versioning
- Moved all python depending packages to 'docker.io/gallvp/python3npkgs:v0.6'
Fixed
- All modules are now emitting versioning information
- Fixed a bug which caused LAI to run with null assembly fasta
- Fixed FASTA_LTRRETRIEVER_LAI sub-workflow so that it respects
monoploid_ids
parameter.
Dependencies
- NextFlow!>=23.04.0
- nf-validation@1.1.3
Deprecated
- Removed BIOCODE GFF3 STATS owing to its frequent failures