Skip to content

nf-test: default config - #830

Merged
jfy133 merged 8 commits into
devfrom
test-default-config
Jun 18, 2025
Merged

nf-test: default config#830
jfy133 merged 8 commits into
devfrom
test-default-config

Conversation

@jfy133

@jfy133 jfy133 commented Jun 18, 2025

Copy link
Copy Markdown
Member

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 pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • 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).

@jfy133 jfy133 changed the title Test default config nf-test: default config Jun 18, 2025
@github-actions

github-actions Bot commented Jun 18, 2025

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 0b516b5

+| ✅ 357 tests passed       |+
#| ❔   3 tests were ignored |#
!| ❗  48 tests had warnings |!
Details

❗ Test warnings:

  • pipeline_todos - TODO string in main.nf: Remove this line if you don't need a FASTA file [TODO: try and test using for --host_fasta and --host_genome]
  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • local_component_structure - gtdbtk_db_preparation.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - gtdbtk_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - adjust_maxbin2_ext.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - rename_predastool.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - pool_single_reads.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bowtie2_assembly_build.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bowtie2_removal_build.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bowtie2_removal_align.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - rename_postdastool.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - mag_depths.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - nanolyse.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - quast.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - split_fasta.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - quast_bins.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - tiara_classify.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - convert_depths.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - mag_depths_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bowtie2_assembly_align.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - pool_paired_reads.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - mag_depths_plot.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - quast_bins_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - bin_summary.nf in modules/local should be moved to a TOOL/SUBTOOL/main.nf structure
  • local_component_structure - binning.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - bin_qc.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - virus_identification.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - hybrid_assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - tiara.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_binning_preparation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - ancient_dna.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_binning_preparation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - binning_refinement.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - catpack.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_hostremoval.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - assembly.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - longread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - shortread_preprocessing.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - binning_preparation.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - gtdbtk.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - depths.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure
  • local_component_structure - domain_classification.nf in subworkflows/local should be moved to a SUBWORKFLOW_NAME/main.nf structure

❔ Tests ignored:

✅ Tests passed:

Run details

  • nf-core/tools version 3.3.1
  • Run at 2025-06-18 09:44:08

Comment thread conf/modules.config
@jfy133

jfy133 commented Jun 18, 2025

Copy link
Copy Markdown
Member Author

@nf-core-bot fix linting

@JoseEspinosa JoseEspinosa left a comment

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.

LGTM! Just some small suggestions but only formatting issues and a possible tyop, so feel free to merge once you go throw them

Comment thread tests/default.nf.test
Comment on lines +16 to +18
// // stable_name: All files + folders in ${params.outdir}/ with a stable name
// def stable_name = getAllFilesFromDir(params.outdir, relative: true, includeDir: true, ignore: ['pipeline_info/*.{html,json,txt}'])
// // stable_path: All files in ${params.outdir}/ with stable content

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.

Suggested change
// // stable_name: All files + folders in ${params.outdir}/ with a stable name
// def stable_name = getAllFilesFromDir(params.outdir, relative: true, includeDir: true, ignore: ['pipeline_info/*.{html,json,txt}'])
// // stable_path: All files in ${params.outdir}/ with stable content
// stable_name: All files + folders in ${params.outdir}/ with a stable name
// def stable_name = getAllFilesFromDir(params.outdir, relative: true, includeDir: true, ignore: ['pipeline_info/*.{html,json,txt}'])
// stable_path: All files in ${params.outdir}/ with stable content

Comment thread tests/default.nf.test
Comment on lines +27 to +30
// // All stable path name, with a relative path
// stable_name,
// // All files with stable contents
// stable_path

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.

Suggested change
// // All stable path name, with a relative path
// stable_name,
// // All files with stable contents
// stable_path
// All stable path name, with a relative path
// stable_name,
// All files with stable contents
// stable_path

Comment thread conf/modules.config
mode: params.publish_dir_mode,
pattern: "*.{bam,bai}",
enabled: params.save_assembly_mapped_reads
enabled: params.save_assembly_mapped_reads,

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.

Is the comma here needed?

Suggested change
enabled: params.save_assembly_mapped_reads,
enabled: params.save_assembly_mapped_reads

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.

I asked on slack and seems that the nxf server likes it, I don't... 😄

@jfy133

jfy133 commented Jun 18, 2025

Copy link
Copy Markdown
Member Author

I'm going to rudely ignore the suggestions and go blindly with the approval 😆

Context:

  1. I won't question language server, not a rebel like you
  2. I'm leaving the double comments, as when I reactivate the snapshots agian, I want to keep the descriptions as comments (I use keyboard shortcuts to comment/uncomment)

But I appreciate the ✔️ !

@jfy133
jfy133 marked this pull request as ready for review June 18, 2025 10:57
@jfy133
jfy133 merged commit cb0dbc7 into dev Jun 18, 2025
@dialvarezs
dialvarezs deleted the test-default-config branch November 21, 2025 11:37
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