LFQBench Web工具交付前自查Checklist

来自OmicsWiki
跳到导航 跳到搜索

EasyDIA / LFQBench 及类似 Web 分析工具上线或交付前自查。

1. 基础信息

  • [ ] 项目 ID、数据路径、代码路径、运行环境已记录。
  • [ ] 当前代码版本或提交号已记录。
  • [ ] 输入文件、参数、阈值、分组表、比较组已归档。
  • [ ] 明确本次交付范围:ProteinGroup、Precursor、或二者均包含。

2. 环境与依赖

  • [ ] R 版本已记录。
  • [ ] Shiny 运行环境已确认。
  • [ ] 必需 R 包均可加载。
  • [ ] 后端脚本可在 VM 上执行。
  • [ ] 文件路径、权限、读写目录正常。
  • [ ] Windows 与 VM 间脚本同步后无编码问题。

3. 代码检查

  • [ ] LFQBench.Rparse
  • [ ] LFQBench_script.Rparse
  • [ ] LFQBench_core_generation.Rparse
  • [ ] 无硬编码项目 ID。
  • [ ] 无硬编码物种颜色。
  • [ ] 无硬编码 condition 颜色。
  • [ ] 所有关键异常有日志或 summary 记录。

4. 后端运行检查

  • [ ] protein demo 运行成功。
  • [ ] precursor demo 运行成功。
  • [ ] 完整或准完整项目运行成功。
  • [ ] backend_error.log 无 ERROR。
  • [ ] rerun log 无 ERROR。
  • [ ] warning 已评估且不影响交付。
  • [ ] 结果包大小已记录。

5. 输出文件完整性

  • [ ] 结果 ZIP 存在且可下载。
  • [ ] ZIP 可正常解压。
  • [ ] LFQBench_result.rda 存在。
  • [ ] Scatter PNG/CSV 存在。
  • [ ] Box PNG/CSV 存在。
  • [ ] Diff counts/proportion PNG/CSV 存在。
  • [ ] Completeness/CV PNG/CSV 存在。
  • [ ] Violin PNG/CSV 存在。
  • [ ] Correlation PNG/CSV 存在。
  • [ ] Qualitative IDs PNG/CSV 存在。
  • [ ] CSV 均有表头。
  • [ ] 空结果也有结构化空表或 summary。
  • [ ] 不打包冗余超大 PDF。

6. 页面基础功能

  • [ ] 页面可打开,无整页红色 Error。
  • [ ] 每个模块的 Plot tab 可打开。
  • [ ] 每个模块的 Table tab 可打开。
  • [ ] Download 按钮可用。
  • [ ] 切换层级后页面不报错。
  • [ ] 切换比较组后页面不报错。
  • [ ] 页面刷新后仍可正常显示已有结果。

7. 表格功能

  • [ ] 表格有搜索框。
  • [ ] 表格可选择每页条数。
  • [ ] 表格有完整分页按钮。
  • [ ] 表格有 Go to page 跳页。
  • [ ] 搜索后 Go to page 仍存在。
  • [ ] 翻页后 Go to page 仍存在。
  • [ ] 表格支持横向滚动。
  • [ ] 明细表包含 ProteinGroup 或 Precursor。
  • [ ] 数值列保留合理小数位。

8. 图表通用检查

  • [ ] 所有标题清晰。
  • [ ] 坐标轴标题清晰。
  • [ ] 图例完整。
  • [ ] 字体大小可读。
  • [ ] 数字标签无遮挡。
  • [ ] 样本名不被截断或可通过横向滚动查看。
  • [ ] 物种名完整显示或有合理换行。
  • [ ] 图表边距足够。
  • [ ] 全文图表风格一致。
  • [ ] 中文和英文描述分行显示,术语一致。

9. 颜色一致性

  • [ ] Condition 颜色由输入分组动态生成。
  • [ ] Species 颜色由输入物种动态生成。
  • [ ] 同一 condition 在所有图中颜色一致。
  • [ ] 同一 species 在所有图中颜色一致。
  • [ ] 图例顺序与数据/表格顺序一致。
  • [ ] 缺失或未知物种有稳定颜色或明确标记。

10. LFQBench 专项图表检查

Scatter / Ratio distribution

  • [ ] 横坐标为 mean log2 abundance 或对应 log2Quantity。
  • [ ] 纵坐标为 log2 numerator / denominator。
  • [ ] expected ratio 参考线正确。
  • [ ] actual ratio 和 SD 标注正确。
  • [ ] 右侧 density 分布正常。
  • [ ] protein 层 hover 可显示 feature 和物种信息。
  • [ ] precursor 层性能可接受。

Box / Group

  • [ ] 按 abundance 分箱正确。
  • [ ] 参考线对应 expected ratio。
  • [ ] 每个分箱中位数标注正确。
  • [ ] 图例位于右侧且完整。
  • [ ] 按物种分面可读。

Diff counts & proportion

  • [ ] Count Plot 可读。
  • [ ] Prop Plot 与 Count Plot 同尺寸展示。
  • [ ] 差异阈值和用户参数一致。
  • [ ] t-test / BH 只在重复数足够时执行。
  • [ ] 单样本时 p/adj.p 不产生误导。
  • [ ] 物种名完整。

Completeness / CV

  • [ ] |log2FC| 区间正确。
  • [ ] completeness 计算口径明确。
  • [ ] CV 计算口径明确。
  • [ ] 样本不足时 CV 显示 NA 或跳过。
  • [ ] 数字标签无遮挡。

Violin / Quantity distribution

  • [ ] 样本名完整或可滚动查看。
  • [ ] condition 颜色一致。
  • [ ] normalization 前/后数据源已说明。
  • [ ] 整体和按物种需求已确认。

Correlation

  • [ ] by group 为组内样本相关性。
  • [ ] by species 可选择单个物种查看。
  • [ ] 默认不展示压缩过度的合并图。
  • [ ] 样本 label map 存在。
  • [ ] 相关系数表存在。
  • [ ] 样本数不足时不报错。

Qualitative IDs

  • [ ] stacked 图存在且可读。
  • [ ] panel 图存在且可读。
  • [ ] stacked 表存在。
  • [ ] panel 表存在。
  • [ ] ProteinGroup 和 Precursor 分开输出。
  • [ ] 无检测结果时也有结构化空表。

11. 单样本专项检查

  • [ ] 单样本输入可运行完成。
  • [ ] 需要重复的统计不强行计算。
  • [ ] 表格中 NA、空值、跳过原因一致。
  • [ ] 图表不出现互相矛盾的数值。
  • [ ] 页面无红色 Error。
  • [ ] 结果说明中明确单样本限制。

12. 交付文档

  • [ ] 交付计划已更新。
  • [ ] 运行命令已记录。
  • [ ] 结果路径已记录。
  • [ ] 已知问题和限制已记录。
  • [ ] 自查 Checklist 已完成。
  • [ ] Wiki 版文档已准备。
  • [ ] 技术部门审核意见已记录。

13. 最终验收

  • [ ] 技术负责人确认运行成功。
  • [ ] 技术负责人确认报告页面无 Error。
  • [ ] 技术负责人确认结果文件完整。
  • [ ] 技术负责人确认图表格式一致。
  • [ ] 技术负责人确认文档可交付。
  • [ ] 产品或项目负责人确认需求覆盖范围。