diff --git a/CHANGELOG.md b/CHANGELOG.md index 564f058..9e88180 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,18 +5,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [[2.0.0](https://github.com/sanger-tol/ensemblgenedownload/releases/tag/2.0.0)] – Vicious Uruk-hai – [2024-05-24] -### `Fixed` +This version supports the new FTP structure of Ensembl + +### Enhancements & fixes - Support for the updated directory structure of the Ensembl FTP - Relative paths in the sample-sheet are now evaluated from the `--outdir` parameter - Memory usage rules for `samtools dict` - Appropriate use of `tabix`'s TBI and CSI indexing, depending on the sequence lengths - -### `Added` - - New command-line parameter (`--annotation_method`): required for accessing the files on the Ensembl FTP - `--outdir` is a _mandatory_ parameter +### Parameters + +| Old parameter | New parameter | +| ------------- | ------------------- | +| | --annotation_method | + +_In the samplesheet_ + +| Old parameter | New parameter | +| ------------- | ----------------- | +| species_dir | outdir | +| | annotation_method | +| assembly_name | | + +> **NB:** Parameter has been **updated** if both old and new parameter information is present.
**NB:** Parameter has been **added** if just the new parameter information is present.
**NB:** Parameter has been **removed** if new parameter information isn't present. + +### Software dependencies + +Note, since the pipeline is using Nextflow DSL2, each process will be run with its own [Biocontainer](https://biocontainers.pro/#/registry). 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. Only `Docker` or `Singularity` containers are supported, `conda` is not supported. + +| Dependency | Old version | New version | +| ---------- | ----------- | ----------- | +| multiqc | 1.13 | 1.14 | + ## [[1.0.1](https://github.com/sanger-tol/ensemblgenedownload/releases/tag/1.0.1)] [2022-10-19] Minor bugfix update.