Bio workflow methods docwriter
Skill BioTender-max/awesome-bio-agent-skills/skills/omics/bio-workflow-methods-docwriter
Generate reproducible Methods documentation from workflow run artifacts (Nextflow/Snakemake/CWL), including exact commands, versions, parameters, QC gates, and outputs.From its SKILL.md
npx -y skills add BioTender-max/awesome-bio-agent-skills --skill bio-workflow-methods-docwriterAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
One thing to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
SKILL.md
1.6 KB, 328 tokens by cl100k_base, as published. Nobody here has run it
Bio Workflow Methods Docwriter
Create publication-ready Methods and run documentation from real workflow artifacts.
Instructions
- Collect the workflow evidence package (logs, configs, version files).
- Build
run_manifest.yamlstrictly from evidence. - Validate the manifest against the schema.
- Draft
METHODS.mdwith a concise workflow summary at the top. - Verify QC gates and reproducibility details are captured.
Quick Reference
| Task | Action |
|---|---|
| Evidence checklist | See reference/evidence-checklist.md |
| Manifest schema | schemas/run-manifest.schema.json |
| Validate manifest | python scripts/validate_run_manifest.py run_manifest.yaml |
| Examples | See examples/ |
Input Requirements
- Workflow artifacts (Nextflow/Snakemake/CWL logs and configs)
- Tool version records or container digests
- QC reports and output manifests
Output
METHODS.md(workflow summary + detailed steps)run_manifest.yaml(machine-readable run manifest)
Quality Gates
- No invented commands, versions, or parameters
- Every step has inputs, outputs, and versions captured
- Workflow summary appears at top of
METHODS.md
Examples
Example 1: Validate a manifest
python scripts/validate_run_manifest.py run_manifest.yaml
Troubleshooting
Issue: Missing tool versions in logs
Solution: Mark as NOT CAPTURED and add a note on how to capture next time.
What ships with it: 11 files
22.0 KB alongside SKILL.md, 2 of them executable
examples/
reference/
- evidence-checklist.md2.0 KB
- standards.md719 B
schemas/
- bio-paper-schema.yaml2.6 KB
- run-manifest.schema.json5.2 KB
- workflow-run-schema.yaml2.7 KB
scripts/
- extract_nextflow_run.pyruns4.4 KB
- validate_run_manifest.pyruns1.3 KB
templates/
- methods_report.md1.0 KB
- paper_summary.yaml627 B
- requirements.txt18 B