You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Minor editorial improvements to module creation section
- Change "understand" to "learned" for better flow
- Replace "boilerplate" with clearer "extra code"
- Expand resource label explanation to introduce the concept
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
Copy file name to clipboardExpand all lines: docs/hello_nf-core/04_make_module.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -592,7 +592,7 @@ However, you might want to keep it as a reference for understanding the differen
592
592
593
593
## 2. Use nf-core tooling to create modules
594
594
595
-
Now that you understand the nf-core module patterns by applying them manually, let's look at how you'd create modules in practice.
595
+
Now that you've learned the nf-core module patterns by applying them manually, let's look at how you'd create modules in practice.
596
596
The nf-core project provides the `nf-core modules create` command that generates properly structured module templates with all these patterns built in from the start.
597
597
598
598
### 2.1. Using nf-core modules create
@@ -605,14 +605,14 @@ For example, to create the `cowpy` module with a minimal template:
605
605
nf-core modules create --empty-template cowpy
606
606
```
607
607
608
-
The `--empty-template` flag creates a clean starter template without extra boilerplate, making it easier to see the essential structure.
608
+
The `--empty-template` flag creates a clean starter template without extra code, making it easier to see the essential structure.
609
609
610
610
The command runs interactively, guiding you through the setup. It automatically looks up tool information from package repositories like Bioconda and bio.tools to pre-populate metadata.
611
611
612
-
You'll be prompted for:
612
+
You'll be prompted for several configuration options:
613
613
614
614
-**Author information**: Your GitHub username for attribution
615
-
-**Resource label**: The computational requirements (e.g., `process_single` for lightweight tools, `process_high` for demanding ones)
615
+
-**Resource label**: A predefined set of computational requirements. nf-core provides standard labels like `process_single` for lightweight tools and `process_high` for demanding ones. These labels help manage resource allocation across different execution environments.
616
616
-**Metadata requirement**: Whether the module needs sample-specific information via a `meta` map (usually yes for data processing modules)
617
617
618
618
The tool handles the complexity of finding package information and setting up the structure, allowing you to focus on implementing the tool's specific logic.
@@ -771,7 +771,7 @@ For detailed instructions, see the [nf-core components tutorial](https://nf-co.r
771
771
772
772
## Takeaway
773
773
774
-
You now know how to create nf-core modules! You learned the three key patterns that make modules portable and maintainable:
774
+
You now know how to create nf-core modules! You learned the four key patterns that make modules portable and maintainable:
775
775
776
776
-**Metadata tuples** track sample information through the workflow
777
777
-**`ext.args`** simplifies module interfaces by handling optional arguments via configuration
0 commit comments