Fix Hello Genomics tutorials for v2 syntax parser#777
Merged
vdauwera merged 15 commits into3.0-feature-strict-syntaxfrom Jan 28, 2026
Merged
Fix Hello Genomics tutorials for v2 syntax parser#777vdauwera merged 15 commits into3.0-feature-strict-syntaxfrom
vdauwera merged 15 commits into3.0-feature-strict-syntaxfrom
Conversation
- Remove type annotation from array parameter declaration (v2 parser doesn't allow `reads_bam: Path = [...]`) - Add explanatory note about typed parameters and arrays - Fill in missing TODO output blocks with actual outputs - Update Section 4.2 "Before" block to match Section 3.1 "After" Found during tutorial walkthrough testing with NXF_SYNTAX_PARSER=v2. Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
|
Nextflow linting complete! ❌ 1 files had 1 errors 💡 Tip: Click filename locations to go directly to that code. View all 1 issues
View formatting changes
|
Collaborator
|
Looks good so far! |
Replace publishDir with workflow outputs feature for v2 syntax compatibility: - Remove publishDir from SAMTOOLS_INDEX and GATK_HAPLOTYPECALLER processes - Remove params.outdir, add outputDir to nextflow.config - Add workflow main:/publish: sections and output block - Rename bam_index target to indexed_bam (publishes tuple with both BAM and BAI) - Update all documentation code blocks and output examples - Add results directory contents showing all published files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replace placeholder outputs with actual values from workflow runs: - Section 1.2: Error output with real work directory hashes - Section 1.6: Success output and directory listing - Section 2.5: Syntax error output - Section 2.7: GenomicsDB success output - Section 3.8: Final success output and complete directory listing Also adds missing sections 1.4 and 1.5 for updating publish targets and output block when switching from VCF to GVCF outputs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Replace placeholder directory listings with actual work directory hashes: - Section 1.6: Single sample results directory - Section 2.6: Results after adding GATK_HAPLOTYPECALLER - Section 3.7: Full batch results with all 12 files - Section 3.7: .view() tuple output examples Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Update genomics-4.nf with workflow outputs (main:/publish: and output block) - Remove publishDir from solution modules (samtools/index, gatk/haplotypecaller, gatk/jointgenotyping) - Update documentation with real command outputs - Clean up module examples to not mention publishDir - Fix Before/After blocks to use tabbed format Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Convert Before/After blocks to tabbed format - Update all command outputs with real nf-test 0.9.3 outputs - Fill in TODO placeholders for generate commands - Update solution files to use relative script paths - Update nf-test.config syntax (no equals signs) - Update snapshot files with current versions Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Update genomics-2.nf to use workflow outputs (main:/publish:/output{})
instead of publishDir, adding GVCF mode and joint genotyping
- Update genomics-3.nf to match Part 2 endpoint with workflow outputs
- Convert Part 2 documentation to tabbed Before/After format
- Fix orientation page to describe solutions directory accurately
This ensures consistent workflow outputs pattern across all 4 parts.
Co-Authored-By: Claude <noreply@anthropic.com>
The previous ending sounded like the course was complete, but Parts 3 and 4 still follow. Now properly mentions modularization as the next step. Co-Authored-By: Claude <noreply@anthropic.com>
- Fix heading numbering: 1.7 → 1.6 in Part 4 (testing) - Fix admonition syntax: add missing space after !!! in 6 locations Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The tutorial now uses workflow outputs instead of publishDir, so the skeleton file should not include it. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove erroneous -ERC GVCF flag from error output example (that flag is only used in Part 2 for joint calling) - Fill in TODO with the actual GATK error message - The error message is now shown inline in the collapsed output block Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
genomics-2.nf should match the final state of Part 1 tutorial, serving as the starting point for Part 2 (joint calling). Changes from previous state: - Remove cohort_name parameter (added in Part 2) - Remove GATK_JOINTGENOTYPING process (added in Part 2) - Change GATK_HAPLOTYPECALLER to produce .vcf instead of .g.vcf - Remove -ERC GVCF flag (added in Part 2 Section 1) - Simplify workflow to only run indexing and per-sample calling - Update output block to match Part 1 structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- SAMTOOLS_INDEX: Use '$input_bam' (no braces) to match docs - GATK_HAPLOTYPECALLER: Add spacing before comma in emit declarations - GATK_JOINTGENOTYPING: Add spacing before comma in emit declarations These changes ensure solution modules exactly match what learners create when following the Part 3 tutorial documentation. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove unused Part 5 learning objective from index.md - Fix broken link in next_steps.md (../nf4_science/index.md -> ../index.md) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Use 2-space indentation for JSON code block in docs - Add trailing newline to snap file Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
vdauwera
approved these changes
Jan 28, 2026
Collaborator
vdauwera
left a comment
There was a problem hiding this comment.
LGTM! Thanks for getting this done!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes issues found during tutorial walkthrough testing with
NXF_SYNTAX_PARSER=v2(strict syntax parser) and migrates frompublishDirto workflow outputs.Changes
Part 1: Per-sample variant calling
reads_bam: Path = [...]→reads_bam = [...])publishDirto workflow outputs (main:/publish:/output{})publishDirplaceholder from skeleton filePart 2: Joint calling
Part 3: Modules
publishDirfrom solution modulesPart 4: Testing
Intro/Outro
../nf4_science/index.md→../index.md)Testing
🤖 Generated with Claude Code