Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tweaking data-dictionary readme notes #176

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Tweaking data-dictionary readme notes #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/datadictionary.md
View file
Open in desktop
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.