Skip to content

Commit 4b4517d

Browse files
pinin4fjordsclaude
andcommitted
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]>
1 parent e5301ca commit 4b4517d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/hello_nf-core/04_make_module.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@ However, you might want to keep it as a reference for understanding the differen
592592

593593
## 2. Use nf-core tooling to create modules
594594

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.
596596
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.
597597

598598
### 2.1. Using nf-core modules create
@@ -605,14 +605,14 @@ For example, to create the `cowpy` module with a minimal template:
605605
nf-core modules create --empty-template cowpy
606606
```
607607

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.
609609

610610
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.
611611

612-
You'll be prompted for:
612+
You'll be prompted for several configuration options:
613613

614614
- **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.
616616
- **Metadata requirement**: Whether the module needs sample-specific information via a `meta` map (usually yes for data processing modules)
617617

618618
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
771771

772772
## Takeaway
773773

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:
775775

776776
- **Metadata tuples** track sample information through the workflow
777777
- **`ext.args`** simplifies module interfaces by handling optional arguments via configuration

0 commit comments

Comments
 (0)