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

Template: fix pre-commit lining failing on pipelines template #3218

Merged
merged 5 commits into from
Oct 11, 2024
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
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- Add null/ to .gitignore ([#3191](https://github.com/nf-core/tools/pull/3191))
- Parallelize pipeline GHA tests over docker/conda/singularity ([#3214](https://github.com/nf-core/tools/pull/3214))
- Fix `template_version_comment.yml` github action ([#3212](https://github.com/nf-core/tools/pull/3212))
- Fix pre-commit linting on pipeline template ([#3218](https://github.com/nf-core/tools/pull/3218))

### Linting

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,5 +116,4 @@ jobs:
exit 1
else
echo "The pipeline can be downloaded successfully!"
fi
{% endraw %}{% endif %}
fi{% endraw %}{% endif %}
9 changes: 6 additions & 3 deletions nf_core/pipeline-template/CITATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,14 @@
{% if fastqc %}- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)

> Andrews, S. (2010). FastQC: A Quality Control Tool for High Throughput Sequence Data [Online].
> {% endif %}

{%- endif %}

{% if multiqc %}- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)

> Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.
> {% endif %}

{%- endif %}

## Software packaging/containerisation tools

Expand All @@ -43,4 +45,5 @@
- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)

> Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.
> {%- endif %}

{%- endif %}
2 changes: 1 addition & 1 deletion nf_core/pipeline-template/docs/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Results generated by MultiQC collate pipeline QC from supported tools e.g. FastQ
- `pipeline_info/`
- Reports generated by Nextflow: `execution_report.html`, `execution_timeline.html`, `execution_trace.txt` and `pipeline_dag.dot`/`pipeline_dag.svg`.
{%- if email %}
- Reports generated by the pipeline: `pipeline_report.html`, `pipeline_report.txt` and `software_versions.yml`. The `pipeline_report*` files will only be present if the `--email` / `--email_on_fail` parameter's are used when running the pipeline. {% endif %}
- Reports generated by the pipeline: `pipeline_report.html`, `pipeline_report.txt` and `software_versions.yml`. The `pipeline_report*` files will only be present if the `--email` / `--email_on_fail` parameter's are used when running the pipeline.{% endif %}
- Reformatted samplesheet files used as input to the pipeline: `samplesheet.valid.csv`.
- Parameters used by the pipeline run: `params.json`.

Expand Down
3 changes: 2 additions & 1 deletion nf_core/pipeline-template/main.nf
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ workflow {
params.outdir,
params.input
)
{% endif %}
{%- endif %}

//
// WORKFLOW: Run main workflow
//
Expand Down
6 changes: 3 additions & 3 deletions nf_core/pipeline-template/modules.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
}{% endif %}{%- if multiqc %}{% if fastqc %},{% endif %}
"multiqc": {
"branch": "master",
"git_sha": "b8d36829fa84b6e404364abff787e8b07f6d058c",
"git_sha": "cf17ca47590cc578dfb47db1c2a44ef86f89976d",
"installed_by": ["modules"]
}
{%- endif %}
Expand All @@ -23,12 +23,12 @@
"nf-core": {
"utils_nextflow_pipeline": {
"branch": "master",
"git_sha": "9d05360da397692321d377b6102d2fb22507c6ef",
"git_sha": "3aa0aec1d52d492fe241919f0c6100ebf0074082",
"installed_by": ["subworkflows"]
},
"utils_nfcore_pipeline": {
"branch": "master",
"git_sha": "772684d9d66f37b650c8ba5146ac1ee3ecba2acb",
"git_sha": "1b6b9a3338d011367137808b49b923515080e3ba",
"installed_by": ["subworkflows"]
}{% if nf_schema %},
"utils_nfschema_plugin": {
Expand Down
2 changes: 1 addition & 1 deletion nf_core/pipeline-template/modules/nf-core/multiqc/main.nf

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions nf_core/pipeline-template/nextflow.config
Original file line number Diff line number Diff line change
Expand Up @@ -288,10 +288,10 @@ validation {
"""
afterText = """${manifest.doi ? "* The pipeline\n" : ""}${manifest.doi.tokenize(",").collect { " https://doi.org/${it.trim().replace('https://doi.org/','')}"}.join("\n")}${manifest.doi ? "\n" : ""}
* The nf-core framework
https://doi.org/10.1038/s41587-020-0439-x
https://doi.org/10.1038/s41587-020-0439-x

* Software dependencies
https://github.com/${manifest.name}/blob/master/CITATIONS.md
https://github.com/${manifest.name}/blob/master/CITATIONS.md
"""{% endif %}
}{% if is_nfcore %}
summary {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ workflow PIPELINE_INITIALISATION {
workflow.profile.tokenize(',').intersect(['conda', 'mamba']).size() >= 1
)

{% if nf_schema %}
{%- if nf_schema %}

//
// Validate parameters and generate parameter summary to stdout
//
Expand All @@ -60,7 +61,7 @@ workflow PIPELINE_INITIALISATION {
validate_params,
null
)
{% endif %}
{%- endif %}

//
// Check config provided to the pipeline
Expand All @@ -70,6 +71,7 @@ workflow PIPELINE_INITIALISATION {
)

{%- if igenomes %}

//
// Custom validation for pipeline parameters
//
Expand Down Expand Up @@ -123,7 +125,7 @@ workflow PIPELINE_COMPLETION {
email // string: email address
email_on_fail // string: email address sent on pipeline failure
plaintext_email // boolean: Send plain-text email instead of HTML
{% endif %}
{%- endif %}
outdir // path: Path to output directory where results will be published
monochrome_logs // boolean: Disable ANSI colour codes in log output
{% if adaptivecard or slackreport %}hook_url // string: hook URL for notifications{% endif %}
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions nf_core/pipeline-template/workflows/pipeline.nf
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,14 @@ workflow {{ short_name|upper }} {
Channel.fromPath(params.multiqc_logo, checkIfExists: true) :
Channel.empty()

{% if nf_schema %}
{%- if nf_schema %}

summary_params = paramsSummaryMap(
workflow, parameters_schema: "nextflow_schema.json")
ch_workflow_summary = Channel.value(paramsSummaryMultiqc(summary_params))
ch_multiqc_files = ch_multiqc_files.mix(
ch_workflow_summary.collectFile(name: 'workflow_summary_mqc.yaml'))
{% endif %}
{%- endif %}

{%- if citations %}
ch_multiqc_custom_methods_description = params.multiqc_methods_description ?
Expand Down
Loading