Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 5.8 KB

CONTRIBUTING.md

File metadata and controls

58 lines (39 loc) · 5.8 KB

收录与维护规范

返回首页

收录单位与范围

重点收录可用于多基因组比对和泛基因组研究的组装基因组、模拟数据及基准集。图、注释、已有比对结果与真值作为配套资源提供。

一个条目可以是持续维护的研究对象集合,也可以是可识别的数据发布集合或基准集,必须说明来源与所含组装版本。持续集合允许追加物种、组装和版本;固定发布集保留原发布范围。不将整个数据库作为具体数据集,也不单独扩展论文库、工具库或原始测序数据目录。

同一集合的常规版本更新保留在同一详情中,各下载入口注明版本。具有独立名称、明确样本集合和评测定义的派生基准集单独收录,说明与原始数据的关系。原始数据已收录时使用内部链接,否则提供官方来源。

文件与分类

  • 先按研究对象建立 datasets/<group>/,例如 datasets/human/ 与 datasets/primate/。一个研究对象含多个资源时,条目放在 datasets/<group>/<dataset-id>/README.md;持续集合也可以直接使用 datasets/<group>/README.md。标识采用稳定的小写英文字母、数字与连字符。
  • 持续集合使用研究对象或项目的稳定名称,例如 primates;名称和标识不包含当前条目数、用途或 T2T 状态。数量只写在当前规模或历史记录中。普通版本更新与分类调整不改变详情路径。
  • 每个数据集只在一个主要分类列表中出现;真实数据的归属见分类约定。
  • 模拟数据归入模拟目录。真实与模拟混合且模拟部分不可独立理解时整套归入模拟目录,说明组成和关联数据。
  • 不按 MGA、Pangenome 或 T2T 再复制条目;这些信息作为字段维护。

持续集合与组装级别

  • 以完整 accession(含版本)作为组装记录标识,允许同种多个组装。追加新版本时保留旧版本与来源,不将所有记录静默替换为 latest。
  • 当前清单与展示表同步维护;需要保存实验选样范围时,在条目内保存带日期的来源清单或引用确定的 Git 提交。历史核验范围不随当前清单增长而扩张。
  • 新增记录填写自己的来源和核验日期;实验使用、真值、T2T 等结论只适用于有证据的记录,不自动继承整个集合的标签。
  • 仓库级别使用 T2T、Chromosome、Scaffold、Contig;对来源为 Complete Genome 且缺少 T2T 证据的组装保留 Complete Genome,未知用未明确,模拟数据可用不适用。
  • 有与 accession 版本及组装范围对应的发布者说明或论文证据时,仓库级别归为 T2T,不再计入 Chromosome 或 Complete Genome。另存来源数据库原始级别、T2T 依据及核验日期。
  • 缺少 T2T 证据时保留来源级别并注明 T2T 待核实;不把它写成已确认非T2T。每个 accession 在级别统计中只计一次。

新增流程

  1. 检查现有条目,确认不是同一发布集合的重复收录或常规版本更新。
  2. 复制条目模板到新条目目录,填写来源、范围、字段与下载入口。删除模板提示,未知信息用“未明确”或“待核实”,不要猜测。
  3. 确定唯一主要分类,向对应列表加入摘要。真实分类页尚不存在时,按约定文件名创建,沿用真实目录给出的六列表头。
  4. 创建真实分类页时,在首页“真实数据”和真实目录“已收录分类”同时添加直接链接。首页直接进入分类列表,随后一次点击进入详情。
  5. 在详情“所属目录”填写具体分类列表的相对链接;分类页添加返回首页和上级目录的链接。所有仓库内部链接使用相对路径。
  6. 检查链接、数量单位、版本、用途证据、真值与许可信息。没有下载时,文件内容验证记录必须保持“未验证(未下载)”。
  7. 粗体字段标签统一写成 **字段**:正文,将中文冒号放在粗体标记之外;不要写成 **字段:**正文,以免 Markdown 解析器把星号原样显示。

模板当前导航指向模板所在位置的上级目录。复制到 datasets/<group>/<dataset-id>/README.md 后,按模板注释将首页和数据目录链接分别改为 ../../../README.md 和 ../../../catalog/README.md,并添加研究对象目录及具体分类入口。

列表与扩展

分类页仅展示用于选择数据集的简要信息,下载链接及完整依据只放详情。同组内按数据集名称排序,不手工维护数量统计。

单个列表超过 50 个条目时拆成子列表,原页面保留为导航入口:真实数据按已有物种或类群分组,模拟数据按原始项目或基准系列分组。子列表放在同名目录下,例如原 plants.md 保留,子列表放到 plants/。移动列表链接而不移动数据集详情,并同步返回导航和详情所属目录。

初始未拆分阶段,首页直接链接分类列表,数据集详情最多两次点击可达;规模扩大后允许增加一级导航,不以复制条目维持点击次数。

更新与核验

  • 优先使用官方项目与权威数据仓库的稳定入口;没有稳定直链时保留落地页和 accession,不构造猜测地址。
  • 对每个实际检查的入口记录日期、结果和访问条件。入口可访问不能证明文件完整或内容正确。
  • 链接失效时标明状态,查找官方迁移入口;版本替换须保留必要的旧版本对应关系。
  • 区分原研究使用、后续研究使用和维护者判断的潜在用途,记录证据或判断理由。
  • 外部数据、论文及配套资源遵循自身条款,不因被收录而适用本仓库文档许可。

字段和证据要求详见数据说明。