'Required' terminology

Abierto
#757 3 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado

Línea de trabajo

Comience con la definición introductoria de “Required” en la documentación de OMOP CDM y revise las descripciones de las columnas y las tablas que utilizan esta terminología. Identifique cómo la redacción o una nota aclaratoria puede indicar de forma coherente que todas las columnas deberían existir, mientras que las columnas que no son “Required” pueden ser NULL; la tarea estará terminada cuando la distinción sea clara en toda la documentación afectada.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
HTML
Estrellas
1.1k
Forks
515
Merge medio
8 d 3 h
PR fusionados (30 d)
4

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OHDSI/CommonDataModel

Todos los issues de OHDSI/CommonDataModel

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.