Skip to content

Commit

Permalink
Tweaking data-dictionary readme notes
Browse files Browse the repository at this point in the history
Added reference variable code and clarity on the data_type enumerated values.
  • Loading branch information
torstees authored Jan 31, 2025
1 parent 4d87c98 commit 99072e8
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/datadictionary.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ The data should be a valid, ASCII only CSV file with double quotes used for "Quo
| *Column Name* | *Column Descriptions* | *Column Type* |
| ------------ | --------------------- | ------------- |
| *variable_name* | The human readable name associated with variable name | String |
| *variable_code* | (optional) machine friendly column header. This must not contain any forward slashes "/". It is recommended that only alphanumeric characters with dashes/underscores. | String |
| *description* | Fully informative description of the contents associated with this variable/column| String |
| *data_type* | Data type associated with column data | integer, number, string, enumeration |
| *data_type* | Data type associated with column data | Acceptable enumerated values include: integer, number, string, enumeration |
| *min* | Minimum value (integers and numbers only) | numeric value |
| *max* | Maximum acceptable value (integers and numbers only) | numeric value |
| *units* | UCUM code for units | UCUM code prefixed with the curie, UCUM. UCUM:ml for example |
Expand All @@ -28,4 +29,4 @@ In this example, the following codes are extracted: 1, 2, 0 and -1 and assigned
If there is no code specified, the codes will be created using the following logic:
> Case is dropped to lower case and potentially problematic characters, such as parenthesis, "(" or ")" will be removed. Whitespace characters will be replaced with underscores, "_".
There is currently no way to allow codes or values to include semi-colons, ";", or equal signs, "=" in them. They should be replaced prior to loading into Map Dragon.
There is currently no way to allow codes or values to include semi-colons, ";", or equal signs, "=" in them. They should be replaced prior to loading into Map Dragon.

0 comments on commit 99072e8

Please sign in to comment.