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

Important! Template update for nf-core/tools v2.9 #61

Merged
merged 5 commits into from
Jul 17, 2023

Conversation

nf-core-bot
Copy link
Member

Version 2.9 of nf-core/tools has just been released with updates to the nf-core template. This automated pull-request attempts to apply the relevant updates to this pipeline.

Please make sure to merge this pull-request as soon as possible, resolving any merge conflicts in the nf-core-template-merge-2.9 branch (or your own fork, if you prefer). Once complete, make a new minor release of your pipeline.

For instructions on how to merge this PR, please see https://nf-co.re/developers/sync.

For more information about this release of nf-core/tools, please see the v2.9 release page.

@github-actions
Copy link

github-actions bot commented Jul 5, 2023

nf-core lint overall result: Failed ❌

Posted for pipeline commit e691044

+| ✅ 156 tests passed       |+
#| ❔   1 tests were ignored |#
-| ❌   1 tests failed       |-

❌ Test failures:

  • multiqc_config - 'assets/multiqc_config.yml' does not contain a matching 'report_comment'.

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md

✅ Tests passed:

Run details

  • nf-core/tools version 2.9
  • Run at 2023-07-17 09:28:58

Copy link
Member

@mirpedrol mirpedrol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a couple of suggestions :)

assets/multiqc_config.yml Outdated Show resolved Hide resolved
assets/multiqc_config.yml Outdated Show resolved Hide resolved
@@ -206,12 +207,14 @@
"type": "boolean",
"description": "Display help text.",
"fa_icon": "fas fa-question-circle",
"default": false,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can remove all "default": false, this is taken into account by default and will be removed if you use nf-core schema build

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It didn't automatically remove the defaults, but I removed them manually now.

def summary_params = paramsSummaryMap(workflow)

// Print parameter summary log to screen
log.info logo + paramsSummaryLog(workflow) + citation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[This is a comment for line 29] The schema is now validating that params.input exists, so you could skip this check here.
The same stands for other file parameters, you can add the flag "exists": true in nextflow_schema.json and remove those checks from the main pipeline code :)

@@ -189,7 +190,7 @@
"description": "Maximum amount of time that can be requested for any single job.",
"default": "240.h",
"fa_icon": "far fa-clock",
"pattern": "^(\\d+\\.?\\s*(s|m|h|day)\\s*)+$",
"pattern": "^(\\d+\\.?\\s*(s|m|h|d|day)\\s*)+$",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to clarify: This was introduced by the update, not by you?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, this is from the template update: see here

@WackerO
Copy link

WackerO commented Jul 13, 2023

You could also consider removing the TODOs that the update introduced :)

Copy link
Member

@mirpedrol mirpedrol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

@SusiJo SusiJo merged commit 17ce013 into dev Jul 17, 2023
@SusiJo SusiJo deleted the nf-core-template-merge-2.9 branch July 17, 2023 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants