search

CAST-genomics / haptools

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

docs: describe how to add to our CLI #193

Closed aryarm closed 1 year ago

aryarm commented 1 year ago

This PR adds documentation that describes how to add to our CLI. It should be useful for any potential contributors to our codebase!

The new section is on the Contributing page of our docs.

aryarm commented 1 year ago

converting to draft b/c we should also mention that they should create new tests and add proper documentation for new commands

and for new options, they should consider adding an example to the documentation for that command

If an existing option or argument is ever changed, we should label it as a breaking change

We should also add a citation to our manuscript, fix the publishing instructions, and add --max-alleles 2 to the plink2 command on the Genotypes docs page