diff options
Diffstat (limited to 'doc/file-formats.md')
| -rw-r--r-- | doc/file-formats.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/file-formats.md b/doc/file-formats.md index 4d3bfcd..be8162f 100644 --- a/doc/file-formats.md +++ b/doc/file-formats.md @@ -5,7 +5,18 @@ The summary file is ASCII encoded. It consists of two sections—the header and The first line of the header section MUST be `# pyhegp summary file version 1`. Subsequent lines of the header section are a list of key-value pairs. Each line MUST be `#`, optional whitespace, the key, a single space character and then the value. The key MUST NOT contain whitespace or control characters, and MUST NOT begin with a `#` character. The value MAY contain whitespace characters, but MUST NOT contain control characters. -The data section is a tab-separated table of numbers. The first line of the data section is a vector of means—one for each SNP. The second line is a vector of standard deviations—one for each SNP. +The data section is a tab-separated table of numbers. The first line MUST be a header with column labels. Each row corresponds to one SNP. The columns labelled `chromosome`, `position`, `reference`, `mean` and `standard-deviation` contain the chromosome, the position of the SNP on the chromosome, the reference allele, the mean dosage and the standard deviation of the dosage for that SNP. Column labels are case-sensitive. + +The `reference` column is optional, and SHOULD be absent in pooled summary files. Here is an example summary file. `TODO: Add example.` + +## genotype file + +The genotype file is a tab-separated values (TSV) file. The first line MUST be a header with column labels. Each row corresponds to one SNP. The columns labelled `chromosome`, `position` and `reference` contain the chromosome, the position on the chromosome and the reference allele for that SNP. Other columns each contain dosage values for one sample. The headers of these columns MUST be their sample identifiers. Column headers are case-sensitive. + +the `reference` column is optional, and should be absent in encrypted genotype files. + +Here is an example genotype file. +`TODO: Add example.` |