Skip to content

Merging template updates 2.2#269

Merged
d4straub merged 18 commits intonf-core:devfrom
d4straub:merging-template-updates-2.2
Feb 10, 2022
Merged

Merging template updates 2.2#269
d4straub merged 18 commits intonf-core:devfrom
d4straub:merging-template-updates-2.2

Conversation

@d4straub
Copy link
Copy Markdown
Collaborator

@d4straub d4straub commented Feb 2, 2022

This is nf-core template update 2.2. I attempted to retain the folder structure, I hope I didn't miss anything.
I only did -profile test to make sure the output is identical to the dev branch.

Linting is failing with files_unchanged.github/workflows/linting.yml does not match the template because I changed to node version 16, because the previous node version 10 is not working any more with Markdown linting. nf-core template will get an update soon.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
    • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
    • If necessary, also make a PR on the nf-core/mag branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 2, 2022

nf-core lint overall result: Passed ✅

Posted for pipeline commit 63b4be5

+| ✅ 139 tests passed       |+
#| ❔   1 tests were ignored |#
Details

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: lib/NfcoreTemplate.groovy

✅ Tests passed:

Run details

  • nf-core/tools version 2.2
  • Run at 2022-02-02 12:35:05

@jfy133 jfy133 self-requested a review February 9, 2022 12:35
Copy link
Copy Markdown
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

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

Everything looks fine to me, only minor issue are:

  1. bin_summary is possibly missing from modules.config (for consistency)
  2. sed used for command reporting for a lot of utils (cat, tar). I don't remember what version of coreutils are in the biocontainers, but might be worth to check cat tar etc. don't report their own versions (if you have not done so already of course)

Comment thread conf/modules.config Outdated
}

withName: CENTRIFUGE {
ext.args = '--quiet'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This wasn't in the syntax v1 DSL2 modules.config, and I don't see it in the old local module - is it correct this has been added here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Good catch! This is incorrect I think, I'll remove it!

Comment thread conf/modules.config
Comment on lines +237 to +253
withName: GTDBTK_SUMMARY {
ext.args = "--extension fa"
publishDir = [
path: { "${params.outdir}/Taxonomy/GTDB-Tk" },
mode: 'copy',
saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
]
}

withName: PROKKA {
ext.args = "--metagenome"
publishDir = [
path: { "${params.outdir}/Prokka/${meta.assembler}" },
mode: 'copy',
saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
]
}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Original modules.config had a module called bin_summary between these, is it correct this is not now here?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

max_memory = 6.GB
max_time = 48.h
max_memory = '6.GB'
max_time = '6.h'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Correct this has been droped to 48.h? (Same goes for all subsequent test profiles)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Comment thread modules/local/cat_db.nf Outdated

cat <<-END_VERSIONS > versions.yml
"${task.process}":
sed: \$(sed --version 2>&1 | sed -n 1p | sed 's/sed (GNU sed) //')
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

shouldn't this be tar?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

changed to tar

Comment thread modules/local/busco_db_preparation.nf Outdated

cat <<-END_VERSIONS > versions.yml
"${task.process}":
sed: \$(sed --version 2>&1 | sed -n 1p | sed 's/sed (GNU sed) //')
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Shouldn't this be tar?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

changed to tar

Comment thread modules/local/pool_paired_reads.nf Outdated

cat <<-END_VERSIONS > versions.yml
"${task.process}":
sed: \$(sed --version 2>&1 | sed -n 1p | sed 's/sed (GNU sed) //')
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

sed -> cat?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

changed to cat

Comment thread modules/local/pool_single_reads.nf Outdated

cat <<-END_VERSIONS > versions.yml
"${task.process}":
sed: \$(sed --version 2>&1 | sed -n 1p | sed 's/sed (GNU sed) //')
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

sed -> cat?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

changed to cat

Comment thread modules/local/spades.nf Outdated

script:
def software = getSoftwareName(task.process)
def spades_options = params.spades_options ?: ''
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Shouldn't this be passed via ext.args? If you are evaluating spades_options somewhere 'higher' (i.e. workflow, or subworkflow) this can also be done in modules.config

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

You are right, that is not evaluated at any other point, so I moved it so modules.config.

Comment thread modules/local/spadeshybrid.nf Outdated

script:
def software = getSoftwareName(task.process)
def spades_options = params.spades_options ?: ''
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

See comment in local/spades.nf

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

same as above, moved it so modules.config.

Comment thread workflows/mag.nf
Comment on lines +10 to +12
def hasExtension(it, extension) {
it.toString().toLowerCase().endsWith(extension.toLowerCase())
}
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Could this go in a custom functions file in lib and be imported? Although maybe overkill for a single tiny function

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I kept it where it is now, I agree that this is not the place it is supposed to be but readability is sort of better this way I think.

@d4straub d4straub merged commit b8b8658 into nf-core:dev Feb 10, 2022
@d4straub d4straub deleted the merging-template-updates-2.2 branch February 10, 2022 07:38
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.

3 participants