'Required' terminology

未关闭
  • 哪里不对？
#757 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

从 OMOP CDM 文档中对“Required”的介绍性定义开始，检查使用这一术语的列描述和表。确定如何通过措辞或免责声明一致地说明每一列都应存在，而非 Required 的列可以为 NULL；当整个受影响的文档中这一差异都清晰明确时，即视为完成。

由索引模型根据 Issue 内容生成。

描述

Documentation

In the OMOP CDM documentation for each of the columns it is stated if the column is required or not. Required meaning if it can be left missing or it must be populated.

Image

At the beginning of the documentation it is stated: Similarly, fields that are not required should exist in the CDM table but do not need to be populated.

Although I acknowledge it is stated in the documentation, maybe the word is not the best wording as I've found at least 3 OMOP CDM instances of independent groups that seemed to have misunderstood "required" as if the column must exist. And then they didn't create the columns that have required = No.

Do you think we could find a better word or add a disclaimer in every table (e.g required* and then in the foot note: the column must always exists but if not required it can be left as NULL)? Just to prevent other users to do the same mistake.

主要语言
HTML
星标
1.1k
派生
515
平均合并
10 天 13 小时
30 天内合并 PR
3

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

OHDSI/CommonDataModel 的其他 Issue

查看 OHDSI/CommonDataModel 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。