Merge pull request #738 from nf-core/nf-core-template-merge-3.1.1

Important! Template update for nf-core/tools v3.1.1
nf-core · Jan 20, 2025 · 28dfa97 · 28dfa97
2 parents 54ea4f2 + 7ac02b0
commit 28dfa97
Show file tree

Hide file tree

Showing 11 changed files with 60 additions and 35 deletions.
diff --git 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
@@ -9,7 +9,6 @@ body:
 
         - [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
         - [nf-core/mag pipeline documentation](https://nf-co.re/mag/usage)
-
   - type: textarea
     id: description
     attributes:

diff --git a/.github/workflows/download_pipeline.yml b/.github/workflows/download_pipeline.yml
@@ -28,8 +28,12 @@ env:
   NXF_ANSI_LOG: false
 
 jobs:
-  download:
+  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: Install Nextflow
         uses: nf-core/setup-nextflow@v2
@@ -53,65 +57,70 @@ jobs:
           pip install git+https://github.com/nf-core/tools.git@dev
 
       - name: Get the repository name and current branch set as environment variable
+        id: get_repo_properties
         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}
+          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"
 
       - name: Make a cache directory for the container images
         run: |
           mkdir -p ./singularity_container_images
 
+  download:
+    runs-on: ubuntu-latest
+    needs: configure
+    steps:
       - name: Download the pipeline
         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/" \
           --container-cache-utilisation 'amend' \
           --download-configuration 'yes'
 
       - name: Inspect download
-        run: tree ./${{ env.REPOTITLE_LOWERCASE }}
+        run: tree ./${{ needs.configure.outputs.REPOTITLE_LOWERCASE }}
 
       - 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
         continue-on-error: true
         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

diff --git a/.nf-core.yml b/.nf-core.yml
@@ -5,7 +5,7 @@ lint:
     - config_defaults:
         - params.phix_reference
         - params.lambda_reference
-nf_core_version: 3.1.0
+nf_core_version: 3.1.1
 repository_type: pipeline
 template:
   author: "Hadrien Gourlé, Daniel Straub, Sabrina Krakau, James A. Fellows Yates,

diff --git a/.prettierignore b/.prettierignore
@@ -10,3 +10,4 @@ testing/
 testing*
 *.pyc
 bin/
+ro-crate-metadata.json
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Hadrien Gourlé, Daniel Straub, Sabrina Krakau, James A. Fellows Yates, Maxime Borry
+Copyright (c) The nf-core/mag 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
@@ -3,11 +3,10 @@
     <source media="(prefers-color-scheme: dark)" srcset="docs/images/mag_logo_mascot_dark.png">
     <img alt="nf-core/mag" src="docs/images/mag_logo_mascot_light.png">
   </picture>
-</h1>
-
-[![GitHub Actions CI Status](https://github.com/nf-core/mag/actions/workflows/ci.yml/badge.svg)](https://github.com/nf-core/mag/actions/workflows/ci.yml)
+</h1>[![GitHub Actions CI Status](https://github.com/nf-core/mag/actions/workflows/ci.yml/badge.svg)](https://github.com/nf-core/mag/actions/workflows/ci.yml)
 [![GitHub Actions Linting Status](https://github.com/nf-core/mag/actions/workflows/linting.yml/badge.svg)](https://github.com/nf-core/mag/actions/workflows/linting.yml)[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?labelColor=000000&logo=Amazon%20AWS)](https://nf-co.re/mag/results)[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.3589527-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.3589527)
-[![nf-test](https://img.shields.io/badge/unit_tests-nf--test-337ab7.svg)](https://www.nf-test.com)[![Cite Publication](https://img.shields.io/badge/Cite%20Us!-Cite%20Publication-orange)](https://doi.org/10.1093/nargab/lqac007)
+[![nf-test](https://img.shields.io/badge/unit_tests-nf--test-337ab7.svg)](https://www.nf-test.com)
+[![Cite Publication](https://img.shields.io/badge/Cite%20Us!-Cite%20Publication-orange)](https://doi.org/10.1093/nargab/lqac007)
 
 [![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A524.04.2-23aa62.svg)](https://www.nextflow.io/)
 [![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)

diff --git a/assets/multiqc_config.yml b/assets/multiqc_config.yml
@@ -1,8 +1,7 @@
 report_comment: >
-  This report has been generated by the <a href="https://github.com/nf-core/mag/tree/dev"
-  target="_blank">nf-core/mag</a> analysis pipeline. For information about how to
-  interpret these results, please see the <a href="https://nf-co.re/mag/dev/docs/output"
-  target="_blank">documentation</a>.
+  This report has been generated by the <a href="https://github.com/nf-core/mag/tree/dev" target="_blank">nf-core/mag</a>
+  analysis pipeline. For information about how to interpret these results, please see the
+  <a href="https://nf-co.re/mag/dev/docs/output" target="_blank">documentation</a>.
 report_section_order:
   "nf-core-mag-methods-description":
     order: -1000

diff --git a/docs/usage.md b/docs/usage.md
@@ -189,7 +189,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/ro-crate-metadata.json b/ro-crate-metadata.json
@@ -105,7 +105,7 @@
             },
             "mentions": [
                 {
-                    "@id": "#69a630c2-4ecb-45c8-aa72-507b7379fdc9"
+                    "@id": "#21020cd0-8c47-4a1a-84a3-6e758cb60d64"
                 }
             ],
             "name": "nf-core/mag"
@@ -127,7 +127,11 @@
         },
         {
             "@id": "main.nf",
-            "@type": ["File", "SoftwareSourceCode", "ComputationalWorkflow"],
+            "@type": [
+                "File",
+                "SoftwareSourceCode",
+                "ComputationalWorkflow"
+            ],
             "creator": [
                 {
                     "@id": "#[email protected]"
@@ -163,7 +167,9 @@
                 "nanopore",
                 "nanopore-sequencing"
             ],
-            "license": ["MIT"],
+            "license": [
+                "MIT"
+            ],
             "maintainer": [
                 {
                     "@id": "#[email protected]"
@@ -178,15 +184,22 @@
                     "@id": "https://orcid.org/0000-0001-9807-1082"
                 }
             ],
-            "name": ["nf-core/mag"],
+            "name": [
+                "nf-core/mag"
+            ],
             "programmingLanguage": {
                 "@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow"
             },
             "sdPublisher": {
                 "@id": "https://nf-co.re/"
             },
-            "url": ["https://github.com/nf-core/mag", "https://nf-co.re/mag/dev/"],
-            "version": ["3.3.1dev"]
+            "url": [
+                "https://github.com/nf-core/mag",
+                "https://nf-co.re/mag/dev/"
+            ],
+            "version": [
+                "3.3.1dev"
+            ]
         },
         {
             "@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow",
@@ -383,4 +396,4 @@
             "name": "Hadrien Gourl\u00e9"
         }
     ]
-}
+}
diff --git a/subworkflows/local/utils_nfcore_mag_pipeline/main.nf b/subworkflows/local/utils_nfcore_mag_pipeline/main.nf
@@ -176,6 +176,7 @@ workflow PIPELINE_COMPLETION {
     main:
     summary_params = paramsSummaryMap(workflow, parameters_schema: "nextflow_schema.json")
     def multiqc_reports = multiqc_report.toList()
+
     //
     // Completion email and summary
     //
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,3 +10,4 @@ testing/ @@
     testing*
     *.pyc
     bin/
+    ro-crate-metadata.json