[issue/273] Add documentation on delimiters being replaced #306
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
akotlar
commented
Oct 19, 2023
akotlar
commented
- Add documentation on delimiters being replaced by "," at build time.
poneill
approved these changes
Oct 20, 2023
FIELDS.md
Outdated
| @@ -6,16 +6,14 @@ | |||
| ### General output information: | |||
| <p style="margin-left: 40px"> Missing data in the annotation is marked by <strong>'!'</strong> </p> | |||
| <p style="margin-left: 40px"> Multiple values for a single annotated position are separated by <strong>';'</strong> </p> | |||
| <p style="margin-left: 40px"> Multiple values for a single annotated position that are nested within <strong>';'</strong> delimited values (e.g 2D values) are separated by <strong>ASCII UNIT SEPARATOR (ASCII code 31)</strong> </p> | |||
There was a problem hiding this comment.
it might help to give a small example of when such a structure might occur, and what the data would look like in that case
There was a problem hiding this comment.
Good suggestion, will take care of that in the morning.
FIELDS.md
Outdated
| - When multiple dbSNP rows overlap, we store each field at that position in a 1D array, which loses the relationship between dbSNP.alleles and dbSNP.name | ||
| Reserved characters for use as delimiters | ||
| - ";" "|", ASCII UNIT SEPARATOR (ASCII character 31) | ||
| - "/" will replace the ASCII UNIT SEPARATOR character 31 |
There was a problem hiding this comment.
these lines might be clearer with additional language like: "currently... in a future release..."
FIELDS.md
Outdated
| Reserved characters for use as delimiters | ||
| - ";" "|", ASCII UNIT SEPARATOR (ASCII character 31) | ||
| - "/" will replace the ASCII UNIT SEPARATOR character 31 | ||
| - Any instances os these chracters in values to be inserted into the database at build time, will be replaced at build time with a "," |
| - When multiple dbSNP rows overlap, we store each field at that position in a 1D array, which loses the relationship between dbSNP.alleles and dbSNP.name | ||
| <br/> | ||
|
|
||
| - Missing data in the annotation is marked by **`!`** |
There was a problem hiding this comment.
Update how missing data is marked 'NA'/nan.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.