Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 2.1.0 #152

Merged
merged 4 commits into from
Dec 9, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Updated docs ahead of release
BethYates committed Nov 20, 2024
commit ae8db5c266081742cd17fe114496cb55b4f15b0a
26 changes: 26 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -3,6 +3,32 @@
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).

## [[2.1.0](https://github.com/sanger-tol/genomenote/releases/tag/2.1.0)] - Pembroke Welsh Corgi [2024-11-20]

### Enhancements & fixes

- New annotation_statistics subworkfow which runs BUSCO in protein mode and generates some basic statistics on the the annotated gene set if provided with a GFF3 file of gene annotations using the `--annotation_set` option.
- The genome_metadata subworkflow now queries Ensembl's GraphQL API to determine if Ensembl has released gene annotation for the assembly being processed.

### Parameters

| Old parameter | New parameter |
| ------------- | ---------------- |
| | --annotation_set |

> **NB:** Parameter has been **updated** if both old and new parameter information is present. </br> **NB:** Parameter has been **added** if just the new parameter information is present. </br> **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.

| Dependency | Old version | New version |
| ---------- | ----------- | ----------- |
| gffread | | 0.12.7 |
| agat | | 1.4.0 |

> **NB:** Dependency has been **updated** if both old and new version information is present. </br> **NB:** Dependency has been **added** if just the new version information is present. </br> **NB:** Dependency has been **removed** if version information isn't present.

## [[2.0.0](https://github.com/sanger-tol/genomenote/releases/tag/2.0.0)] - English Cocker Spaniel [2024-10-10]

### Enhancements & fixes
8 changes: 8 additions & 0 deletions CITATIONS.md
Original file line number Diff line number Diff line change
@@ -12,6 +12,10 @@

## Pipeline tools

- [AGAT](https://github.com/NBISweden/AGAT)

> Dainat J. AGAT: Another Gff Analysis Toolkit to handle annotations in any GTF/GFF format. (Version v1.4.0). Zenodo. https://www.doi.org/10.5281/zenodo.3552717

- [BedTools](https://bedtools.readthedocs.io/en/latest/)

> Quinlan, Aaron R., and Ira M. Hall. “BEDTools: A Flexible Suite of Utilities for Comparing Genomic Features.” Bioinformatics, vol. 26, no. 6, 2010, pp. 841–842., https://doi.org/10.1093/bioinformatics/btq033.
@@ -30,6 +34,10 @@

- [FastK](https://github.com/thegenemyers/FASTK)

- [GFFREAD](https://github.com/gpertea/gffread)

> Pertea G and Pertea M. "GFF Utilities: GffRead and GffCompare [version 1; peer review: 3 approved]". F1000Research 2020, 9:304 https://doi.org/10.12688/f1000research.23297.1

- [MerquryFK](https://github.com/thegenemyers/MERQURY.FK)

- [MultiQC](https://multiqc.info)
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ You will need to supply the assembly accession for the genome you would like to

## Annotation input

If you want to generate statistics on the set of proteins annotated for the assembly you will need to supply a GFF3 file of the predicted protein sequences. The assembly region names used in this file must match the assembly regions names used in the assembly fasta file provided with --fasta
If you want to generate statistics on the geneset annotated for the assembly you will need to supply a GFF3 file of the predicted gene sequences. The assembly region names used in this file must match the assembly regions names used in the assembly fasta file provided with --fasta

```bash
--annotation_set '[Path to annotation file :gff]
2 changes: 1 addition & 1 deletion nextflow.config
Original file line number Diff line number Diff line change
@@ -243,7 +243,7 @@ manifest {
description = """Creating standarised genome assembly publications"""
mainScript = 'main.nf'
nextflowVersion = '!>=22.10.1'
version = '2.0.0'
version = '2.1.0'
doi = '10.5281/zenodo.7949384'
}