search

CAST-genomics / haptools

Ancestry and haplotype aware simulation of genotypes and phenotypes for complex trait analysis
https://haptools.readthedocs.io
MIT License
18 stars 4 forks source link

docs: updates for v0.1.0 #171

Closed aryarm closed 1 year ago

aryarm commented 1 year ago

This PR resolves #169

The main changes are

  1. A new "Motivation" section on the page for the Haplotype file format that motivates the need for a new format and discusses its advantages over the alternatives
  2. A new page titled "Example files" that describes where the example and test files are located as well as how to execute our tests using the example files. We've linked to this page at the bottom of each command's documentation page.
  3. A new "Logging" section on the front page of our documentation that describes how to get log info from haptools