Does the * next to specific field in RabbitInAHat indicate required fields for each CDM table?

OHDSI / WhiteRabbit

WhiteRabbit is a small application that can be used to analyse the structure and contents of a database as preparation for designing an ETL. It comes with RabbitInAHat, an application for interactive design of an ETL to the OMOP Common Data Model with the help of the the scan report generated by White Rabbit.

http://ohdsi.github.io/WhiteRabbit

Apache License 2.0

173 stars 85 forks source link

Does the * next to specific field in RabbitInAHat indicate required fields for each CDM table? #346

Open solmazeradat-aridhia opened 1 year ago

solmazeradat-aridhia commented 1 year ago

Hi,

I had a question about Rabbit In A Hat.

I noticed that next to specific fields in each CDM table an asterisk [*] appears.

I couldn't see anywhere in the documentation http://ohdsi.github.io/WhiteRabbit/RabbitInAHat.html what this represented. I did a comparison between some of the table (for example on the Person table) https://ohdsi.github.io/CommonDataModel/cdm54.html#PERSON and it looks like fields with an * next to them are required fields.

Just wanted to check if this was the case?

Many thanks, Solmaz

MaximMoinat commented 1 year ago

The indeed means the field is required. You might also see a for the source fields, where it means that the field is always populated (i.e. 0% empty).

This is indeed nowhere documented, thanks for raising this issue! Will tag it as documentation and fix in a next round of updates.