'Required' terminology

オープン
  • 何か問題がありますか？
#757 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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
フォーク
513
平均マージ
8日 3時間
マージ済み PR（30日）
4

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OHDSI/CommonDataModel のほかの issue

OHDSI/CommonDataModel の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。