Skip to content

Commit

Permalink
describe phenotypes in a separate page of the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aryarm committed Jul 1, 2022
1 parent def4826 commit bffd27c
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 34 deletions.
7 changes: 7 additions & 0 deletions docs/formats/genotypes.rst
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.
4 changes: 2 additions & 2 deletions docs/formats/haplotypes.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _formats-haplotypes:


.hap
====
Haplotypes
==========

This document describes our custom file format specification for haplotypes: the ``.hap`` file.

Expand Down
31 changes: 0 additions & 31 deletions docs/formats/inputs.rst

This file was deleted.

28 changes: 28 additions & 0 deletions docs/formats/phenotypes.rst
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:
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,9 @@
:hidden:
:maxdepth: 1

formats/inputs.rst
formats/genotypes.rst
formats/haplotypes.rst
formats/phenotypes.rst

.. toctree::
:caption: Commands
Expand Down

0 comments on commit bffd27c

Please sign in to comment.