Skip to content

Commit 6751367

Browse files
authored
Merge pull request #39 from poseidon-framework/snpSet-non-mandatory-rollback
made snpSet non-mandatory, also changed README
2 parents a8b658e + 778e0f7 commit 6751367

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

POSEIDON_yml_fields.tsv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ snpFile 1 genotypeData relative path to snpFile String Path TRUE TRUE
1515
snpFileChkSum 1 genotypeData md5 checksum of the snpFile String FALSE TRUE
1616
indFile 1 genotypeData relative path to indFile String Path TRUE TRUE
1717
indFileChkSum 1 genotypeData md5 checksum of the indFile String FALSE TRUE
18-
snpSet 1 genotypeData Can be either 1240K, HumanOrigins or Other depending on the list of SNPs used String (1240K|HumanOrigins|Other) TRUE FALSE
18+
snpSet 1 genotypeData Can be either 1240K, HumanOrigins or Other depending on the list of SNPs used String (1240K|HumanOrigins|Other) FALSE FALSE
1919
jannoFile 0 relative path to jannoFile String Path FALSE TRUE
2020
jannoFileChkSum 1 genotypeData md5 checksum of the jannoFile String FALSE TRUE
2121
bibFile 0 relative path to bibFile String Path FALSE TRUE

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Genotype data in Poseidon packages is stored either in PLINK (binary) or EIGENST
8282
| SNP file | [`.bim` (extended MAP file)](https://www.cog-genomics.org/plink/1.9/formats#bim) | [`.snp` (snp file)](https://github.com/DReichLab/EIG/blob/fb4fb59065055d3622e0f97f0149588eae630a3e/CONVERTF/README#L67) |
8383
| individual file | [`.fam` (sample information)](https://www.cog-genomics.org/plink/1.9/formats#fam) | [`.ind` (indiv file)](https://github.com/DReichLab/EIG/blob/fb4fb59065055d3622e0f97f0149588eae630a3e/CONVERTF/README#L67) |
8484

85-
In addition to these files and their checksums, you also must provide a `snpSet` entry which determines the shape of the genotype file. Currently, only `1240K`, `HumanOrigins` or `Other` are allowed.
85+
In addition to these files and their checksums, you also should provide a `snpSet` entry which determines the shape of the genotype file. Currently, only `1240K`, `HumanOrigins` or `Other` are allowed. While technically not a mandatory field, for backwards compatibility, we encourage users to set this field, and in fact our software also encourages this through required user input.
8686

8787
## The `.janno` file
8888

0 commit comments

Comments
 (0)