Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion .nf-core.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ template:
name: quantmsdiann
org: bigbio
outdir: .
version: 2.1.0
version: 2.2.0dev
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
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.2.0dev] bigbio/quantmsdiann

### `Changed`

- Documentation: clarified DIA-NN container licensing. Only DIA-NN 1.8.1 is publicly redistributable (pulled from BioContainers as the default); releases from 1.9 onward must be built locally from the [quantms-containers](https://github.com/bigbio/quantms-containers) recipes and tagged `ghcr.io/bigbio/diann:<version>` so the matching `-profile diann_v<version>` resolves them. Added the missing DIA-NN 2.5.0 row to the README support table.

## [2.1.0] bigbio/quantmsdiann — Sao Pablo - 2026-05-05

### `Added`
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,31 @@ The pipeline takes [SDRF](https://github.com/bigbio/proteomics-metadata-standard
| 2.1.0 | `diann_v2_1_0` | `ghcr.io/bigbio/diann:2.1.0` | Native .raw support, Parquet output |
| 2.2.0 | `diann_v2_2_0` | `ghcr.io/bigbio/diann:2.2.0` | Speed optimizations (up to 1.6x on HPC) |
| 2.3.2 | `diann_v2_3_2` | `ghcr.io/bigbio/diann:2.3.2` | DDA support (beta), InfinDIA, up to 9 var mods |
| 2.5.0 | `diann_v2_5_0` | `ghcr.io/bigbio/diann:2.5.0` | +70% protein IDs, DL model selection flags |

Switch versions with e.g. `-profile diann_v2_2_0,docker`. See the [DIA-NN Version Selection](docs/usage.md#dia-nn-version-selection) guide and [full parameter reference](docs/parameters.md) for details.

> [!IMPORTANT]
> **DIA-NN licensing.** Only **DIA-NN 1.8.1** is redistributable and is pulled
> automatically from the public BioContainers image
> (`docker.io/biocontainers/diann:v1.8.1_cv1`), so the default profile works out
> of the box. The DIA-NN license does **not** permit redistribution of releases
> from 1.9 onward, so the `ghcr.io/bigbio/diann:*` images above are **not
> public** — with a valid DIA-NN download you build them locally from the
> [`quantms-containers`](https://github.com/bigbio/quantms-containers) recipes:
>
> ```bash
> git clone https://github.com/bigbio/quantms-containers
> cd quantms-containers/diann-2.5.0
> docker build -t ghcr.io/bigbio/diann:2.5.0 . # Docker
> # or, for Singularity/Apptainer:
> singularity build diann-2.5.0.sif docker-daemon://ghcr.io/bigbio/diann:2.5.0
> ```
>
> The image **must** be tagged `ghcr.io/bigbio/diann:<version>` (matching the
> `Container` column) for the matching `-profile diann_v<version>` to pick it up
> automatically.

## Quick start

> [!NOTE]
Expand Down
2 changes: 1 addition & 1 deletion conf/tests/test_dia_dotd.config
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ params {

// Input data
input = 'https://raw.githubusercontent.com/bigbio/quantms-test-datasets/quantms/testdata/dia_ci_dotd/PXD065380.sdrf.tsv'
database = 'https://raw.githubusercontent.com/bigbio/quantms-test-datasets/quantms/databases/PXD065380.fasta'
database = 'https://raw.githubusercontent.com/bigbio/quantms-test-datasets/quantms/databases/PXD065380/PXD065380.fasta'

min_pr_mz = 350
max_pr_mz = 950
Expand Down
9 changes: 9 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,15 @@ The default DIA-NN version is 1.8.1. To use a different version:

Example: `nextflow run bigbio/quantmsdiann -profile test_dia,docker,diann_v2_2_0`

> [!IMPORTANT]
> DIA-NN's license only permits public redistribution of **version 1.8.1**, which
> is pulled automatically from BioContainers (`docker.io/biocontainers/diann:v1.8.1_cv1`).
> Containers for **1.9 and later are not public**: build them locally from the
> [`quantms-containers`](https://github.com/bigbio/quantms-containers) recipes and
> tag the image `ghcr.io/bigbio/diann:<version>` so the matching
> `-profile diann_v<version>` resolves it, e.g.
> `cd quantms-containers/diann-2.5.0 && docker build -t ghcr.io/bigbio/diann:2.5.0 .`

### Verbose Module Output

Use `-profile verbose_modules` to publish intermediate files from all pipeline steps:
Expand Down
2 changes: 1 addition & 1 deletion nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ manifest {
mainScript = 'main.nf'
defaultBranch = 'main'
nextflowVersion = '!>=25.10.4'
version = '2.1.0'
version = '2.2.0dev'
doi = '10.5281/zenodo.15573386'
}

Expand Down
Loading