Skip to content

Refactor minor fixes#275

Merged
XingerTang merged 1 commit into
AlphaGenes:develfrom
XingerTang:refactor-minor-fixes
Jun 1, 2026
Merged

Refactor minor fixes#275
XingerTang merged 1 commit into
AlphaGenes:develfrom
XingerTang:refactor-minor-fixes

Conversation

@XingerTang

Copy link
Copy Markdown
Contributor

What changed

  • Description of method option
  • Description of alt_allele_prob option
  • Description of genotype probabilities

Why this change

  • method does not have a default value while parsing the arguments, but if there is no input for the option, then the program would run in the multi mode. We can see it as equivalent to having a default value of multi.
  • alt_allele_prob won't give posterior alternative allele probabilities; other options that prompt outputs either give the posterior probabilities, such as seg_prob, hap, or will warn the user during the run, such as pheno_penetrance_prob. Therefore, it is worth noting.
  • Update genotype probabilities format description for sex chromosome for males.

Notes / Risks

  • Minor changes only

Comment thread docs/source/usage.rst Outdated
The first value in each line is the individual ID.
The remaining values are genotype probabilities at each locus.

When working with the X chromosome for male individual, the first line and

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won’t be clear to most as it’s too cryptic.

I suggest the following.

  1. Take the X example input from the above (there id1 and id3 are males…)
  2. Get genotype probabilities for the example
  3. Create a separate output example for the X chromosome below the autosomal chromosome
  4. Add this text above that example
  5. Mention that for females the interpretation is as for an autosomal chromosome below, but for males …

I will then suggest edits

@gregorgorjanc gregorgorjanc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@XingerTang nice that you are polishing these bits! Great! I have suggested some improvements for documenting X chr genotype probability output

Comment thread docs/source/usage.rst Outdated
id4 0.0001 0.0001 0.9999 0.0000
id4 0.0000 0.9999 0.0000 0.0000

When working with the X chromosome, for female individual, the interpretation

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When working with the X chromosome, for female individual, the interpretation
When working with the X chromosome, for a female individual, the interpretation

Comment thread docs/source/usage.rst Outdated
id4 0.0000 0.9999 0.0000 0.0000

When working with the X chromosome, for female individual, the interpretation
is as for an autosomal chromosome above. For male individual, the first line and

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
is as for an autosomal chromosome above. For male individual, the first line and
is as for an autosomal chromosome above. For a male individual, the first line and

Comment thread docs/source/usage.rst Outdated

When working with the X chromosome, for female individual, the interpretation
is as for an autosomal chromosome above. For male individual, the first line and
the last line corresponding to ``a`` and ``A`` respectively, with the middle

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the last line corresponding to ``a`` and ``A`` respectively, with the middle
the last line respectively correspond to ``a`` and ``A`` genotypes, with the middle

Comment thread docs/source/usage.rst Outdated
id4 0.0000 0.0000 0.7088 0.0000
id4 0.0000 0.9999 0.0000 0.0000

When working with the X chromosome, for female individual, the interpretation

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apply the same edits as above

@gregorgorjanc gregorgorjanc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor edits and we merge this in

@XingerTang XingerTang force-pushed the refactor-minor-fixes branch from 4da04e4 to e4afeb3 Compare June 1, 2026 11:39
Comment thread docs/source/usage.rst Outdated
Comment thread docs/source/usage.rst Outdated
Comment thread docs/source/usage.rst Outdated

@gregorgorjanc gregorgorjanc left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge-away @XingerTang ;) Yay.

@gregorgorjanc

Copy link
Copy Markdown
Member

Aha, I assume you squash and merge.

@XingerTang XingerTang force-pushed the refactor-minor-fixes branch from d6d7b8d to 7a37353 Compare June 1, 2026 14:03
@XingerTang

Copy link
Copy Markdown
Contributor Author

Great. Squash done.

@XingerTang XingerTang merged commit 667f063 into AlphaGenes:devel Jun 1, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants