Microbiome Diversity Reporter
When to Use
- - Use this skill when the task needs Interpret Alpha and Beta diversity metrics from 16S rRNA sequencing results.
- Use this skill for academic writing tasks that require explicit assumptions, bounded scope, and a reproducible output format.
- Use this skill when you need a documented fallback path for missing inputs, execution errors, or partial evidence.
Key Features
- - Scope-focused workflow aligned to: Interpret Alpha and Beta diversity metrics from 16S rRNA sequencing results.
- Packaged executable path(s):
scripts/main.py. - Reference material available in
references/ for task-specific guidance. - Structured execution path designed to keep outputs consistent and reviewable.
Dependencies
- - Python 3.8+
- numpy
- pandas
- scipy
- scikit-bio
- matplotlib
- seaborn
- plotly (for interactive charts)
Example Usage
See ## Usage above for related details.
CODEBLOCK0
Example run plan:
- 1. Confirm the user input, output path, and any required config values.
- Edit the in-file
CONFIG block or documented parameters if the script uses fixed settings. - Run
python scripts/main.py with the validated inputs. - Review the generated output and return the final artifact with any assumptions called out.
Implementation Details
See ## Workflow above for related details.
- - Execution model: validate the request, choose the packaged workflow, and produce a bounded deliverable.
- Input controls: confirm the source files, scope limits, output format, and acceptance criteria before running any script.
- Primary implementation surface:
scripts/main.py. - Reference guidance:
references/ contains supporting rules, prompts, or checklists. - Parameters to clarify first: input path, output path, scope filters, thresholds, and any domain-specific constraints.
- Output discipline: keep results reproducible, identify assumptions explicitly, and avoid undocumented side effects.
Quick Check
Use this command to verify that the packaged script entry point can be parsed before deeper execution.
CODEBLOCK1
Audit-Ready Commands
Use these concrete commands for validation. They are intentionally self-contained and avoid placeholder paths.
CODEBLOCK2
Workflow
- 1. Confirm the user objective, required inputs, and non-negotiable constraints before doing detailed work.
- Validate that the request matches the documented scope and stop early if the task would require unsupported assumptions.
- Use the packaged script path or the documented reasoning path with only the inputs that are actually available.
- Return a structured result that separates assumptions, deliverables, risks, and unresolved items.
- If execution fails or inputs are incomplete, switch to the fallback path and state exactly what blocked full completion.
Overview
This tool is used to analyze and interpret diversity metrics in microbiome 16S rRNA sequencing data, including:
- - Alpha Diversity: Species diversity within a single sample
- Beta Diversity: Species composition differences between samples
Usage
Command Line
CODEBLOCK3
Parameter Description
| Parameter | Description | Required |
|---|
| INLINECODE8 | OTU/ASV table path (TSV format) | Yes |
| INLINECODE9 |
Sample metadata (TSV format) | Required for Beta diversity |
|
--metric | Alpha diversity metric: shannon, simpson, chao1, observed_otus | No (default: shannon) |
|
--alpha | Calculate Alpha diversity only | No |
|
--beta | Calculate Beta diversity only | No |
|
--full | Generate full report (Alpha + Beta) | No |
|
--output | Output report path | No (default: stdout) |
|
--format | Output format: html, json, markdown | No (default: html) |
Input Format
OTU Table (TSV)
CODEBLOCK4
Metadata (TSV)
SampleID Group Age Gender
Sample1 Control 25 M
Sample2 Treatment 30 F
Sample3 Treatment 28 M
Output
Generates HTML/JSON/Markdown reports containing:
- 1. Alpha Diversity Results
- Diversity index values
- Rarefaction curves
- Box plots (by group)
- 2. Beta Diversity Results
- PCoA scatter plots
- NMDS plots
- Distance matrix heatmaps
- PERMANOVA statistical tests
- 3. Statistical Summary
- Sample information statistics
- Species richness
- Diversity index distribution
Example Output
CODEBLOCK6
References
- 1. Shannon, C.E. (1948) A mathematical theory of communication
- Simpson, E.H. (1949) Measurement of diversity
- Chao, A. (1984) Non-parametric estimation of classes
- Lozupone et al. (2005) UniFrac: a phylogenetic metric
Risk Assessment
| Risk Indicator | Assessment | Level |
|---|
| Code Execution | Python/R scripts executed locally | Medium |
| Network Access |
No external API calls | Low |
| File System Access | Read input files, write output files | Medium |
| Instruction Tampering | Standard prompt guidelines | Low |
| Data Exposure | Output files saved to workspace | Low |
Security Checklist
- - [ ] No hardcoded credentials or API keys
- [ ] No unauthorized file system access (../)
- [ ] Output does not expose sensitive information
- [ ] Prompt injection protections in place
- [ ] Input file paths validated (no ../ traversal)
- [ ] Output directory restricted to workspace
- [ ] Script execution in sandboxed environment
- [ ] Error messages sanitized (no stack traces exposed)
- [ ] Dependencies audited
Prerequisites
CODEBLOCK7
Evaluation Criteria
Success Metrics
- - [ ] Successfully executes main functionality
- [ ] Output meets quality standards
- [ ] Handles edge cases gracefully
- [ ] Performance is acceptable
Test Cases
- 1. Basic Functionality: Standard input → Expected output
- Edge Case: Invalid input → Graceful error handling
- Performance: Large dataset → Acceptable processing time
Lifecycle Status
- - Current Stage: Draft
- Next Review Date: 2026-03-06
- Known Issues: None
- Planned Improvements:
- Performance optimization
- Additional feature support
Output Requirements
Every final response should make these items explicit when they are relevant:
- - Objective or requested deliverable
- Inputs used and assumptions introduced
- Workflow or decision path
- Core result, recommendation, or artifact
- Constraints, risks, caveats, or validation needs
- Unresolved items and next-step checks
Error Handling
- - If required inputs are missing, state exactly which fields are missing and request only the minimum additional information.
- If the task goes outside the documented scope, stop instead of guessing or silently widening the assignment.
- If
scripts/main.py fails, report the failure point, summarize what still can be completed safely, and provide a manual fallback. - Do not fabricate files, citations, data, search results, or execution outcomes.
Input Validation
This skill accepts requests that match the documented purpose of microbiome-diversity-reporter and include enough context to complete the workflow safely.
Do not continue the workflow when the request is out of scope, missing a critical input, or would require unsupported assumptions. Instead respond:
INLINECODE18 only handles its documented workflow. Please provide the missing required inputs or switch to a more suitable skill.
References
Response Template
Use the following fixed structure for non-trivial requests:
- 1. Objective
- Inputs Received
- Assumptions
- Workflow
- Deliverable
- Risks and Limits
- Next Checks
If the request is simple, you may compress the structure, but still keep assumptions and limits explicit when they affect correctness.
微生物组多样性报告工具
使用时机
- - 当任务需要解读16S rRNA测序结果中的Alpha和Beta多样性指标时使用此技能。
- 用于需要明确假设、限定范围和可重复输出格式的学术写作任务。
- 当需要为缺失输入、执行错误或部分证据提供文档化的回退路径时使用此技能。
主要特性
- - 聚焦范围的工作流程,针对:解读16S rRNA测序结果中的Alpha和Beta多样性指标。
- 打包的可执行路径:scripts/main.py。
- 参考资料位于references/目录,提供任务特定指导。
- 结构化执行路径,确保输出一致且可审查。
依赖项
- - Python 3.8+
- numpy
- pandas
- scipy
- scikit-bio
- matplotlib
- seaborn
- plotly(用于交互式图表)
使用示例
详见上方## 用法部分。
bash
cd 20260318/scientific-skills/Academic Writing/microbiome-diversity-reporter
python -m py_compile scripts/main.py
python scripts/main.py --help
示例运行计划:
- 1. 确认用户输入、输出路径及任何必需的配置值。
- 如果脚本使用固定设置,编辑文件内的CONFIG块或文档化参数。
- 使用验证后的输入运行python scripts/main.py。
- 审查生成的输出,返回最终产物并注明所有假设。
实现细节
详见上方## 工作流程部分。
- - 执行模型:验证请求,选择打包的工作流程,生成限定范围的可交付成果。
- 输入控制:在运行任何脚本前确认源文件、范围限制、输出格式和验收标准。
- 主要实现界面:scripts/main.py。
- 参考指导:references/目录包含支持规则、提示或检查清单。
- 需优先明确的参数:输入路径、输出路径、范围过滤器、阈值及任何领域特定约束。
- 输出规范:保持结果可重复,明确标识假设,避免未文档化的副作用。
快速检查
在深入执行前,使用此命令验证打包脚本入口点是否可解析。
bash
python -m py_compile scripts/main.py
审计就绪命令
使用这些具体命令进行验证。它们特意设计为自包含,避免使用占位符路径。
bash
python -m py_compile scripts/main.py
python scripts/main.py --help
python scripts/main.py -h
工作流程
- 1. 在进行详细工作前,确认用户目标、必需输入和不可协商的约束条件。
- 验证请求是否匹配文档化范围,如果任务需要不受支持的假设则提前停止。
- 仅使用实际可用的输入,使用打包脚本路径或文档化的推理路径。
- 返回结构化结果,区分假设、可交付成果、风险和未解决事项。
- 如果执行失败或输入不完整,切换到回退路径并明确说明阻止完整完成的具体原因。
概述
此工具用于分析和解读微生物组16S rRNA测序数据中的多样性指标,包括:
- - Alpha多样性:单个样本内的物种多样性
- Beta多样性:样本间的物种组成差异
用法
命令行
text
分析单个样本的Alpha多样性
python scripts/main.py --input otu
table.tsv --metric shannon --output alphareport.html
分析Beta多样性(PCoA)
python scripts/main.py --input otu
table.tsv --beta --metadata metadata.tsv --output betareport.html
生成完整报告(Alpha + Beta)
python scripts/main.py --input otu
table.tsv --full --metadata metadata.tsv --output diversityreport.html
参数说明
| 参数 | 说明 | 必需 |
|---|
| --input | OTU/ASV表格路径(TSV格式) | 是 |
| --metadata |
样本元数据(TSV格式) | Beta多样性必需 |
| --metric | Alpha多样性指标:shannon, simpson, chao1, observed_otus | 否(默认:shannon) |
| --alpha | 仅计算Alpha多样性 | 否 |
| --beta | 仅计算Beta多样性 | 否 |
| --full | 生成完整报告(Alpha + Beta) | 否 |
| --output | 输出报告路径 | 否(默认:标准输出) |
| --format | 输出格式:html, json, markdown | 否(默认:html) |
输入格式
OTU表格(TSV)
#OTU ID Sample1 Sample2 Sample3
OTU_1 100 50 200
OTU_2 50 100 0
OTU_3 25 25 50
元数据(TSV)
SampleID Group Age Gender
Sample1 Control 25 M
Sample2 Treatment 30 F
Sample3 Treatment 28 M
输出
生成包含以下内容的HTML/JSON/Markdown报告:
- 1. Alpha多样性结果
- 多样性指数值
- 稀疏曲线
- 箱线图(按分组)
- 2. Beta多样性结果
- PCoA散点图
- NMDS图
- 距离矩阵热图
- PERMANOVA统计检验
- 3. 统计摘要
- 样本信息统计
- 物种丰富度
- 多样性指数分布
示例输出
json
{
alpha_diversity: {
shannon: {
Sample1: 2.45,
Sample2: 1.89,
Sample3: 2.12
},
statistics: {
mean: 2.15,
std: 0.28
}
},
beta_diversity: {
method: braycurtis,
pcoa: {
variance_explained: [0.45, 0.25, 0.15]
}
}
}
参考文献
- 1. Shannon, C.E. (1948) 通信的数学理论
- Simpson, E.H. (1949) 多样性的测量
- Chao, A. (1984) 类别的非参数估计
- Lozupone等 (2005) UniFrac:一种系统发育度量
风险评估
| 风险指标 | 评估 | 等级 |
|---|
| 代码执行 | Python/R脚本本地执行 | 中 |
| 网络访问 |
无外部API调用 | 低 |
| 文件系统访问 | 读取输入文件,写入输出文件 | 中 |
| 指令篡改 | 标准提示指南 | 低 |
| 数据暴露 | 输出文件保存到工作区 | 低 |
安全检查清单
- - [ ] 无硬编码凭据或API密钥
- [ ] 无未经授权的文件系统访问(../)
- [ ] 输出不暴露敏感信息
- [ ] 已实施提示注入保护
- [ ] 输入文件路径已验证(无../遍历)
- [ ] 输出目录限制在工作区内
- [ ] 脚本在沙盒环境中执行
- [ ] 错误消息已清理(不暴露堆栈跟踪)
- [ ] 依赖项已审计
先决条件
text
Python依赖项
pip install -r requirements.txt
评估标准
成功指标
- - [ ] 成功执行主要功能
- [ ] 输出符合质量标准
- [ ] 优雅处理边缘情况
- [ ] 性能可接受
测试用例
- 1. 基本功能:标准输入 → 预期输出
- 边缘情况:无效输入 → 优雅错误处理
- 性能:大数据集 → 可接受的处理时间
生命周期状态
- - 当前阶段:草稿
- 下次审查日期:2026-03-06
- 已知问题:无
- 计划改进:
- 性能优化
- 额外功能支持
输出要求
每个最终响应应在相关时明确以下事项:
- - 目标或请求的可交付成果
- 使用的输入和引入的假设
- 工作流程或决策路径
- 核心结果、建议或产物
- 约束条件、风险、注意事项或验证需求
- 未解决事项和后续检查
错误处理
- - 如果缺少必需输入,明确说明缺少哪些字段,仅请求最少的额外信息。
- 如果任务超出文档化范围,停止而非猜测或静默扩大任务范围。
- 如果scripts/main.py执行失败,报告失败点,总结仍可安全完成的内容,并提供手动回退方案。
- 不得虚构文件、引用、数据、搜索结果或执行结果。
输入验证
此技能接受与microbiome-diversity-reporter文档化目的匹配且包含足够上下文以安全完成