'Required' terminology

Đang mở
  • Có gì không ổn?
#757 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với định nghĩa mở đầu về “Required” trong tài liệu OMOP CDM và xem xét các mô tả cột cũng như các bảng sử dụng thuật ngữ này. Xác định cách diễn đạt hoặc tuyên bố miễn trừ trách nhiệm có thể nêu một cách nhất quán rằng mọi cột đều phải tồn tại, trong khi các cột không phải “Required” có thể là NULL; hoàn tất khi sự phân biệt này rõ ràng trong toàn bộ tài liệu bị ảnh hưởng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
HTML
Star
1.1k
Fork
515
Merge trung bình
10 ngày 13 giờ
Pull request đã merge (30 ngày)
3

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của OHDSI/CommonDataModel

Tất cả issue của OHDSI/CommonDataModel

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.