Skip to content

Commit

Permalink
docs: better showcase example files and their locations in `simgenoty…
Browse files Browse the repository at this point in the history
…pe` (#166)

Co-authored-by: Arya Massarat <[email protected]>
  • Loading branch information
mlamkin7 and aryarm authored Jan 27, 2023
1 parent c98b20f commit 6995407
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/commands/simgenotype.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,11 @@ If speed is important, it's generally faster to use PGEN files than VCFs.
--pop_field \
--out tests/data/example_simgenotype.pgen
Example model files found in `haptools/example-files/models/ <https://github.com/CAST-genomics/haptools/tree/main/example-files/models>`_ and `haptools/tests/data/ <https://github.com/CAST-genomics/haptools/tree/main/tests/data>`_.
Example map files found in `haptools/tests/data/map/ <https://github.com/CAST-genomics/haptools/tree/main/tests/data/map>`_.
Example ref_vcf file can be found `haptools/tests/data/outvcf_test.vcf <https://github.com/CAST-genomics/haptools/blob/main/tests/data/outvcf_test.vcf>`_.
Example sample_info files found in `haptools/example-files/ <https://github.com/CAST-genomics/haptools/tree/main/example-files>`_ and `haptools/tests/data/outvcf_info.tab <https://github.com/CAST-genomics/haptools/blob/main/tests/data/outvcf_info.tab>`_.


Detailed Usage
~~~~~~~~~~~~~~
Expand Down
5 changes: 5 additions & 0 deletions docs/formats/models.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,8 @@ Example pulse event model.dat file
4 1 0 0
Simulating 40 samples for 4 generations in this case implies the first generation has population freqs ``Admixed=0, CEU=0.2, YRI=0.8`` the second generation is purely admixed, the third has an event where a pure CEU population is introduced again at freqs ``Admixed=0.5, CEU=0.5, YRI=0`` and finally we end with pure admixture.

More Example files
------------------
We have generated example model files that simulate current population structures within different populations in America as well as the Caribbean that can be found in the haptools repository here: `haptools/example-files/models/ <https://github.com/CAST-genomics/haptools/tree/main/example-files/models>`_
There are additional example model files that can be found in the haptools repository under `haptools/tests/data/ <https://github.com/CAST-genomics/haptools/tree/main/tests/data>`_
5 changes: 4 additions & 1 deletion haptools/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ def karyogram(bp, sample, out, title, centromeres, colors, verbosity):
"--model",
type=str,
required=True,
help="Admixture model in .dat format. See docs for info.",
help=(
"Admixture model in .dat format. See File Formats under simgenotype in the "
"docs for complete info."
),
)
@click.option(
"--mapdir",
Expand Down

0 comments on commit 6995407

Please sign in to comment.