diff --git a/.editorconfig b/.editorconfig
index 72dda28..6d9b74c 100644
--- a/.editorconfig
+++ b/.editorconfig
@@ -31,3 +31,7 @@ indent_size = unset
# ignore python and markdown
[*.{py,md}]
indent_style = unset
+
+# ignore ro-crate metadata files
+[**/ro-crate-metadata.json]
+insert_final_newline = unset
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index 5bcf7a8..6e640ab 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -9,7 +9,6 @@ body:
- [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
- [nf-core/seqinspector pipeline documentation](https://nf-co.re/seqinspector/usage)
-
- type: textarea
id: description
attributes:
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index f6c5814..d6fc106 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -46,6 +46,8 @@ jobs:
steps:
- name: Check out pipeline code
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+ with:
+ fetch-depth: 0
- name: Set up Nextflow
uses: nf-core/setup-nextflow@v2
diff --git a/.github/workflows/download_pipeline.yml b/.github/workflows/download_pipeline.yml
index 2576cc0..ab06316 100644
--- a/.github/workflows/download_pipeline.yml
+++ b/.github/workflows/download_pipeline.yml
@@ -28,8 +28,23 @@ env:
NXF_ANSI_LOG: false
jobs:
+ configure:
+ runs-on: ubuntu-latest
+ outputs:
+ REPO_LOWERCASE: ${{ steps.get_repo_properties.outputs.REPO_LOWERCASE }}
+ REPOTITLE_LOWERCASE: ${{ steps.get_repo_properties.outputs.REPOTITLE_LOWERCASE }}
+ REPO_BRANCH: ${{ steps.get_repo_properties.outputs.REPO_BRANCH }}
+ steps:
+ - name: Get the repository name and current branch
+ id: get_repo_properties
+ run: |
+ echo "REPO_LOWERCASE=${GITHUB_REPOSITORY,,}" >> "$GITHUB_OUTPUT"
+ echo "REPOTITLE_LOWERCASE=$(basename ${GITHUB_REPOSITORY,,})" >> "$GITHUB_OUTPUT"
+ echo "REPO_BRANCH=${{ github.event.inputs.testbranch || 'dev' }}" >> "$GITHUB_OUTPUT"
+
download:
runs-on: ubuntu-latest
+ needs: configure
steps:
- name: Install Nextflow
uses: nf-core/setup-nextflow@v2
@@ -52,12 +67,6 @@ jobs:
python -m pip install --upgrade pip
pip install git+https://github.com/nf-core/tools.git@dev
- - name: Get the repository name and current branch set as environment variable
- run: |
- echo "REPO_LOWERCASE=${GITHUB_REPOSITORY,,}" >> ${GITHUB_ENV}
- echo "REPOTITLE_LOWERCASE=$(basename ${GITHUB_REPOSITORY,,})" >> ${GITHUB_ENV}
- echo "REPO_BRANCH=${{ github.event.inputs.testbranch || 'dev' }}" >> ${GITHUB_ENV}
-
- name: Make a cache directory for the container images
run: |
mkdir -p ./singularity_container_images
@@ -66,9 +75,9 @@ jobs:
env:
NXF_SINGULARITY_CACHEDIR: ./singularity_container_images
run: |
- nf-core pipelines download ${{ env.REPO_LOWERCASE }} \
- --revision ${{ env.REPO_BRANCH }} \
- --outdir ./${{ env.REPOTITLE_LOWERCASE }} \
+ nf-core pipelines download ${{ needs.configure.outputs.REPO_LOWERCASE }} \
+ --revision ${{ needs.configure.outputs.REPO_BRANCH }} \
+ --outdir ./${{ needs.configure.outputs.REPOTITLE_LOWERCASE }} \
--compress "none" \
--container-system 'singularity' \
--container-library "quay.io" -l "docker.io" -l "community.wave.seqera.io/library/" \
@@ -76,14 +85,17 @@ jobs:
--download-configuration 'yes'
- name: Inspect download
- run: tree ./${{ env.REPOTITLE_LOWERCASE }}
+ run: tree ./${{ needs.configure.outputs.REPOTITLE_LOWERCASE }}
+
+ - name: Inspect container images
+ run: tree ./singularity_container_images | tee ./container_initial
- name: Count the downloaded number of container images
id: count_initial
run: |
image_count=$(ls -1 ./singularity_container_images | wc -l | xargs)
echo "Initial container image count: $image_count"
- echo "IMAGE_COUNT_INITIAL=$image_count" >> ${GITHUB_ENV}
+ echo "IMAGE_COUNT_INITIAL=$image_count" >> "$GITHUB_OUTPUT"
- name: Run the downloaded pipeline (stub)
id: stub_run_pipeline
@@ -91,30 +103,31 @@ jobs:
env:
NXF_SINGULARITY_CACHEDIR: ./singularity_container_images
NXF_SINGULARITY_HOME_MOUNT: true
- run: nextflow run ./${{ env.REPOTITLE_LOWERCASE }}/$( sed 's/\W/_/g' <<< ${{ env.REPO_BRANCH }}) -stub -profile test,singularity --outdir ./results
+ run: nextflow run ./${{needs.configure.outputs.REPOTITLE_LOWERCASE }}/$( sed 's/\W/_/g' <<< ${{ needs.configure.outputs.REPO_BRANCH }}) -stub -profile test,singularity --outdir ./results
- name: Run the downloaded pipeline (stub run not supported)
id: run_pipeline
- if: ${{ job.steps.stub_run_pipeline.status == failure() }}
+ if: ${{ steps.stub_run_pipeline.outcome == 'failure' }}
env:
NXF_SINGULARITY_CACHEDIR: ./singularity_container_images
NXF_SINGULARITY_HOME_MOUNT: true
- run: nextflow run ./${{ env.REPOTITLE_LOWERCASE }}/$( sed 's/\W/_/g' <<< ${{ env.REPO_BRANCH }}) -profile test,singularity --outdir ./results
+ run: nextflow run ./${{ needs.configure.outputs.REPOTITLE_LOWERCASE }}/$( sed 's/\W/_/g' <<< ${{ needs.configure.outputs.REPO_BRANCH }}) -profile test,singularity --outdir ./results
- name: Count the downloaded number of container images
id: count_afterwards
run: |
image_count=$(ls -1 ./singularity_container_images | wc -l | xargs)
echo "Post-pipeline run container image count: $image_count"
- echo "IMAGE_COUNT_AFTER=$image_count" >> ${GITHUB_ENV}
+ echo "IMAGE_COUNT_AFTER=$image_count" >> "$GITHUB_OUTPUT"
- name: Compare container image counts
run: |
- if [ "${{ env.IMAGE_COUNT_INITIAL }}" -ne "${{ env.IMAGE_COUNT_AFTER }}" ]; then
- initial_count=${{ env.IMAGE_COUNT_INITIAL }}
- final_count=${{ env.IMAGE_COUNT_AFTER }}
+ if [ "${{ steps.count_initial.outputs.IMAGE_COUNT_INITIAL }}" -ne "${{ steps.count_afterwards.outputs.IMAGE_COUNT_AFTER }}" ]; then
+ initial_count=${{ steps.count_initial.outputs.IMAGE_COUNT_INITIAL }}
+ final_count=${{ steps.count_afterwards.outputs.IMAGE_COUNT_AFTER }}
difference=$((final_count - initial_count))
echo "$difference additional container images were \n downloaded at runtime . The pipeline has no support for offline runs!"
- tree ./singularity_container_images
+ tree ./singularity_container_images > ./container_afterwards
+ diff ./container_initial ./container_afterwards
exit 1
else
echo "The pipeline can be downloaded successfully!"
diff --git a/.nf-core.yml b/.nf-core.yml
index e44eaad..4bf81e7 100644
--- a/.nf-core.yml
+++ b/.nf-core.yml
@@ -1,7 +1,7 @@
lint:
files_unchanged:
- .github/CONTRIBUTING.md
-nf_core_version: 3.1.0
+nf_core_version: 3.1.1
repository_type: pipeline
template:
author: Adrien Coulier
diff --git a/.prettierignore b/.prettierignore
index 437d763..edd29f0 100644
--- a/.prettierignore
+++ b/.prettierignore
@@ -10,3 +10,4 @@ testing/
testing*
*.pyc
bin/
+ro-crate-metadata.json
diff --git a/CITATIONS.md b/CITATIONS.md
index 208cfa1..a8aaa88 100644
--- a/CITATIONS.md
+++ b/CITATIONS.md
@@ -14,6 +14,8 @@
> Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].
+- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)
+
- [SeqFu](https://telatin.github.io/seqfu2/)
> Telatin A, Fariselli P, Birolo G. SeqFu: A Suite of Utilities for the Robust and Reproducible Manipulation of Sequence Files. Bioengineering 2021, 8, 59. doi.org/10.3390/bioengineering8050059
diff --git a/LICENSE b/LICENSE
index f3045f2..3295b9f 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) Adrien Coulier
+Copyright (c) The nf-core/seqinspector team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index 6cf36dc..c60b7df 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,6 @@
-
[](https://github.com/nf-core/seqinspector/actions/workflows/ci.yml)
[](https://github.com/nf-core/seqinspector/actions/workflows/linting.yml)[](https://nf-co.re/seqinspector/results)[](https://doi.org/10.5281/zenodo.XXXXXXX)
[](https://www.nf-test.com)
@@ -88,9 +87,7 @@ For further information or help, don't hesitate to get in touch on the [Slack `#
## Citations
-
-
-
+
An extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.
diff --git a/docs/usage.md b/docs/usage.md
index 01211f2..6830278 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -133,7 +133,7 @@ Several generic profiles are bundled with the pipeline which instruct the pipeli
> [!IMPORTANT]
> We highly recommend the use of Docker or Singularity containers for full pipeline reproducibility, however when this is not possible, Conda is also supported.
-The pipeline also dynamically loads configurations from [https://github.com/nf-core/configs](https://github.com/nf-core/configs) when it runs, making multiple config profiles for various institutional clusters available at run time. For more information and to check if your system is suported, please see the [nf-core/configs documentation](https://github.com/nf-core/configs#documentation).
+The pipeline also dynamically loads configurations from [https://github.com/nf-core/configs](https://github.com/nf-core/configs) when it runs, making multiple config profiles for various institutional clusters available at run time. For more information and to check if your system is supported, please see the [nf-core/configs documentation](https://github.com/nf-core/configs#documentation).
Note that multiple profiles can be loaded, for example: `-profile test,docker` - the order of arguments is important!
They are loaded in sequence, so later profiles can overwrite earlier profiles.
diff --git a/nextflow.config b/nextflow.config
index 9ab822e..3f726e0 100644
--- a/nextflow.config
+++ b/nextflow.config
@@ -57,7 +57,6 @@ params {
// Load base.config by default for all pipelines
includeConfig 'conf/base.config'
-includeConfig 'conf/modules.config'
profiles {
debug {
@@ -286,3 +285,6 @@ validation {
afterText = validation.help.afterText
}
}
+
+// Load modules.config for DSL2 module specific options
+includeConfig 'conf/modules.config'
diff --git a/ro-crate-metadata.json b/ro-crate-metadata.json
index 24c84dc..3d6459e 100644
--- a/ro-crate-metadata.json
+++ b/ro-crate-metadata.json
@@ -22,8 +22,8 @@
"@id": "./",
"@type": "Dataset",
"creativeWorkStatus": "InProgress",
- "datePublished": "2024-12-12T11:24:30+00:00",
- "description": "