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 93a7927..0a3ec6b 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/denovotranscript pipeline documentation](https://nf-co.re/denovotranscript/usage)
-
- type: textarea
id: description
attributes:
diff --git a/.github/workflows/download_pipeline.yml b/.github/workflows/download_pipeline.yml
index 2576cc0..13b51e2 100644
--- 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,22 +57,27 @@ 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/" \
@@ -76,14 +85,14 @@ jobs:
--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
@@ -91,27 +100,27 @@ 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
diff --git a/.nf-core.yml b/.nf-core.yml
index b58eca6..6886576 100644
--- a/.nf-core.yml
+++ b/.nf-core.yml
@@ -2,7 +2,7 @@ lint:
nextflow_config:
- config_defaults:
- params.ribo_database_manifest
-nf_core_version: 3.1.0
+nf_core_version: 3.1.1
repository_type: pipeline
template:
author: Avani Bhojwani and Timothy Little
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/CHANGELOG.md b/CHANGELOG.md
index d4fe799..5c2cd2c 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [PR #25](https://github.com/nf-core/denovotranscript/pull/25) - Bump version to 1.2.0dev
- [PR #27](https://github.com/nf-core/denovotranscript/pull/27) - Update spades resources and usage instructions
- [PR #28](https://github.com/nf-core/denovotranscript/pull/28) - Template update for nf-core/tools v3.1.0
+- [PR #29](https://github.com/nf-core/denovotranscript/pull/29) - Template update for nf-core/tools v3.1.1
## v1.1.0 - [2024-11-28]
diff --git a/LICENSE b/LICENSE
index 2073772..d461a7e 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) Avani Bhojwani and Timothy Little
+Copyright (c) The nf-core/denovotranscript 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 de42a77..83e08e9 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,6 @@
-
[](https://github.com/nf-core/denovotranscript/actions/workflows/ci.yml)
[](https://github.com/nf-core/denovotranscript/actions/workflows/linting.yml)[](https://nf-co.re/denovotranscript/results)[](https://doi.org/10.5281/zenodo.13324371)
[](https://www.nf-test.com)
diff --git a/docs/usage.md b/docs/usage.md
index cb2bbd5..e9631d2 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -166,7 +166,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 partially supported. Note that Conda is not supported for Transrate in this pipeline.
-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
index 6745e4a..73e9ffc 100644
--- a/ro-crate-metadata.json
+++ b/ro-crate-metadata.json
@@ -21,9 +21,9 @@
{
"@id": "./",
"@type": "Dataset",
- "creativeWorkStatus": "InProgress",
- "datePublished": "2024-12-12T11:22:43+00:00",
- "description": "
\n \n \n \n \n
\n\n[](https://github.com/nf-core/denovotranscript/actions/workflows/ci.yml)\n[](https://github.com/nf-core/denovotranscript/actions/workflows/linting.yml)[](https://nf-co.re/denovotranscript/results)[](https://doi.org/10.5281/zenodo.XXXXXXX)\n[](https://www.nf-test.com)\n\n[](https://www.nextflow.io/)\n[](https://docs.conda.io/en/latest/)\n[](https://www.docker.com/)\n[](https://sylabs.io/docs/)\n[](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/denovotranscript)\n\n[](https://nfcore.slack.com/channels/denovotranscript)[](https://twitter.com/nf_core)[](https://mstdn.science/@nf_core)[](https://www.youtube.com/c/nf-core)\n\n## Introduction\n\n**nf-core/denovotranscript** is a bioinformatics pipeline that ...\n\n\n\n\n\n\n1. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))\n2. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.\n\n\n\nNow, you can run the pipeline using:\n\n\n\n```bash\nnextflow run nf-core/denovotranscript \\\n -profile \\\n --input samplesheet.csv \\\n --outdir \n```\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).\n\nFor more details and further functionality, please refer to the [usage documentation](https://nf-co.re/denovotranscript/usage) and the [parameter documentation](https://nf-co.re/denovotranscript/parameters).\n\n## Pipeline output\n\nTo see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/denovotranscript/results) tab on the nf-core website pipeline page.\nFor more details about the output files and reports, please refer to the\n[output documentation](https://nf-co.re/denovotranscript/output).\n\n## Credits\n\nnf-core/denovotranscript was originally written by Avani Bhojwani and Timothy Little.\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#denovotranscript` channel](https://nfcore.slack.com/channels/denovotranscript) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\n\n\n\n\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nYou can cite the `nf-core` publication as follows:\n\n> **The nf-core framework for community-curated bioinformatics pipelines.**\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n",
+ "creativeWorkStatus": "Stable",
+ "datePublished": "2024-12-20T16:01:12+00:00",
+ "description": "
\n \n \n \n \n
[](https://github.com/nf-core/denovotranscript/actions/workflows/ci.yml)\n[](https://github.com/nf-core/denovotranscript/actions/workflows/linting.yml)[](https://nf-co.re/denovotranscript/results)[](https://doi.org/10.5281/zenodo.XXXXXXX)\n[](https://www.nf-test.com)\n\n[](https://www.nextflow.io/)\n[](https://docs.conda.io/en/latest/)\n[](https://www.docker.com/)\n[](https://sylabs.io/docs/)\n[](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/denovotranscript)\n\n[](https://nfcore.slack.com/channels/denovotranscript)[](https://twitter.com/nf_core)[](https://mstdn.science/@nf_core)[](https://www.youtube.com/c/nf-core)\n\n## Introduction\n\n**nf-core/denovotranscript** is a bioinformatics pipeline that ...\n\n\n\n\n1. Read QC ([`FastQC`](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/))2. Present QC for raw reads ([`MultiQC`](http://multiqc.info/))\n\n## Usage\n\n> [!NOTE]\n> If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how to set-up Nextflow.Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline) with `-profile test` before running the workflow on actual data.\n\n\n\nNow, you can run the pipeline using:\n\n\n\n```bash\nnextflow run nf-core/denovotranscript \\\n -profile \\\n --input samplesheet.csv \\\n --outdir \n```\n\n> [!WARNING]\n> Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_; see [docs](https://nf-co.re/docs/usage/getting_started/configuration#custom-configuration-files).\n\nFor more details and further functionality, please refer to the [usage documentation](https://nf-co.re/denovotranscript/usage) and the [parameter documentation](https://nf-co.re/denovotranscript/parameters).\n\n## Pipeline output\n\nTo see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/denovotranscript/results) tab on the nf-core website pipeline page.\nFor more details about the output files and reports, please refer to the\n[output documentation](https://nf-co.re/denovotranscript/output).\n\n## Credits\n\nnf-core/denovotranscript was originally written by Avani Bhojwani and Timothy Little.\n\nWe thank the following people for their extensive assistance in the development of this pipeline:\n\n\n\n## Contributions and Support\n\nIf you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).\n\nFor further information or help, don't hesitate to get in touch on the [Slack `#denovotranscript` channel](https://nfcore.slack.com/channels/denovotranscript) (you can join with [this invite](https://nf-co.re/join/slack)).\n\n## Citations\n\n\n\n\nAn extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](CITATIONS.md) file.\n\nYou can cite the `nf-core` publication as follows:\n\n> **The nf-core framework for community-curated bioinformatics pipelines.**\n>\n> Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.\n>\n> _Nat Biotechnol._ 2020 Feb 13. doi: [10.1038/s41587-020-0439-x](https://dx.doi.org/10.1038/s41587-020-0439-x).\n",
"hasPart": [
{
"@id": "main.nf"
@@ -99,7 +99,7 @@
},
"mentions": [
{
- "@id": "#5a09edbb-4753-4b22-8846-9052d4237e4e"
+ "@id": "#37d5a66b-f93f-43f5-9f4b-177b6ffbcff2"
}
],
"name": "nf-core/denovotranscript"
@@ -121,21 +121,40 @@
},
{
"@id": "main.nf",
- "@type": ["File", "SoftwareSourceCode", "ComputationalWorkflow"],
+ "@type": [
+ "File",
+ "SoftwareSourceCode",
+ "ComputationalWorkflow"
+ ],
"dateCreated": "",
- "dateModified": "2024-12-12T11:22:43Z",
+ "dateModified": "2024-12-20T17:01:12Z",
"dct:conformsTo": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE/",
- "keywords": ["nf-core", "nextflow", "denovo-assembly", "rna-seq", "transcriptome"],
- "license": ["MIT"],
- "name": ["nf-core/denovotranscript"],
+ "keywords": [
+ "nf-core",
+ "nextflow",
+ "denovo-assembly",
+ "rna-seq",
+ "transcriptome"
+ ],
+ "license": [
+ "MIT"
+ ],
+ "name": [
+ "nf-core/denovotranscript"
+ ],
"programmingLanguage": {
"@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow"
},
"sdPublisher": {
"@id": "https://nf-co.re/"
},
- "url": ["https://github.com/nf-core/denovotranscript", "https://nf-co.re/denovotranscript/dev/"],
- "version": ["1.2.0dev"]
+ "url": [
+ "https://github.com/nf-core/denovotranscript",
+ "https://nf-co.re/denovotranscript/1.0.0/"
+ ],
+ "version": [
+ "1.0.0"
+ ]
},
{
"@id": "https://w3id.org/workflowhub/workflow-ro-crate#nextflow",
@@ -150,11 +169,11 @@
"version": "!>=24.04.2"
},
{
- "@id": "#5a09edbb-4753-4b22-8846-9052d4237e4e",
+ "@id": "#37d5a66b-f93f-43f5-9f4b-177b6ffbcff2",
"@type": "TestSuite",
"instance": [
{
- "@id": "#8b0ce4b0-efb3-47ea-ae93-2e17a51f56da"
+ "@id": "#28ab304b-044c-4d0e-8083-7f0f974724e8"
}
],
"mainEntity": {
@@ -163,7 +182,7 @@
"name": "Test suite for nf-core/denovotranscript"
},
{
- "@id": "#8b0ce4b0-efb3-47ea-ae93-2e17a51f56da",
+ "@id": "#28ab304b-044c-4d0e-8083-7f0f974724e8",
"@type": "TestInstance",
"name": "GitHub Actions workflow for testing nf-core/denovotranscript",
"resource": "repos/nf-core/denovotranscript/actions/workflows/ci.yml",
@@ -292,4 +311,4 @@
"url": "https://nf-co.re/"
}
]
-}
+}
\ No newline at end of file