DReichLab / DReichLab/AdmixTools

qpAdm: Option missing from documentation

Open
#49 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
235
Forks
76
PR merge metrics
No merged PRs in 30d

Description

The option "chrom: 23" to run qpAdm on the X chromosome, as well as the default behaviour of excluding SNPs on the X/Y chromosomes, are not described in the qpAdm README.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the qpAdm README and locate the options section. Document the "chrom: 23" X-chromosome option and the default exclusion of SNPs on the X and Y chromosomes; the README should clearly describe both behaviors.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.