-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
describe phenotypes in a separate page of the docs
- Loading branch information
Showing
5 changed files
with
39 additions
and
34 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.. _formats-genotypes: | ||
|
||
|
||
Genotypes | ||
========= | ||
|
||
Genotype files must be specified as VCF or BCF files. |
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
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
.. _formats-phenotypes: | ||
|
||
|
||
Phenotypes and Covariates | ||
========================= | ||
|
||
Phenotype file format | ||
--------------------- | ||
Phenotypes are expected to follow the PLINK2 ``.pheno`` file format. This is a | ||
tab-separated format where the first column corresponds to the sample ID, and | ||
subsequent columns contain each of your phenotypes. | ||
|
||
The first line of the file corresponds with the header and must begin with ``#IID``. | ||
The names of each of your phenotypes belong in the subbsequent columns of the header. | ||
|
||
See `tests/data/simple.pheno <https://github.com/gymrek-lab/haptools/blob/main/tests/data/simple.pheno>`_ for an example of a phenotype file: | ||
|
||
.. include:: ../../tests/data/simple.pheno | ||
:literal: | ||
|
||
Covariate file format | ||
--------------------- | ||
Covariates follow the same format as phenotypes. | ||
|
||
See `tests/data/simple.covar <https://github.com/gymrek-lab/haptools/blob/main/tests/data/simple.covar>`_ for an example of a covariate file: | ||
|
||
.. include:: ../../tests/data/simple.covar | ||
:literal: |
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