Improve derive attribute documentation with simpler example #50
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
This PR improves the derived attributes documentation by adding a simpler, beginner-friendly example at the start. This addresses user feedback in #37 that the documentation was
too complex and lacked a simple starting point.
Changes
sample_name/data/{sample_name}.fastqAddresses
Closes #37
Before/After
Before: The documentation jumped straight into a complex example with multiple variables (
organism,time) and multiple sources, which was confusing for beginners.After: Users now see a simple 3-sample example first that clearly explains the concept, then can proceed to the more complex example once they understand the basics.
The new example demonstrates the core concept: you define a pattern in your config (e.g.,
my_source: /data/{sample_name}.fastq), reference it in your sample table (file_path: my_source), and peppy expands it automatically.Base branch: mkdocstrings