docs: correct coalescent-opt and skyline CLI help#861
Closed
ivan-aksamentov wants to merge 1 commit into
Closed
Conversation
The --coalescent-opt help described Brent's method, but the estimator is the closed-form Tc = I/M solve with no iteration or initial guess. The skyline help called the model piecewise linear, but Tc(t) is emitted piecewise-constant.
Member
|
makes sense. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/timetree-coalescent-cli-help->rustThe
--coalescent-opthelp described Brent's method with an initial guess, and the--coalescent-skylineand--n-skylinehelp called the model piecewise linear. Both describe superseded implementations.The constant-Tc optimizer is the closed-form maximum-likelihood estimate$\hat{T_c} = I/M$ with no iteration and no initial guess, and the skyline emits a piecewise-constant $T_c(t)$ . This updates the help text to match the shipped behavior.
Work items
--coalescent-opthelp to describe the closed-form--coalescent-skylineand--n-skylinehelp from piecewise-linear to piecewise-constant [src]