Register missing applauncher tools, document them, and print citations - #20
Merged
Conversation
Both were listed as BEASTInterface service providers but had no <packageapp> entry, so applauncher could not find them.
Group all applauncher tools under one heading at the same nesting level, add a section for DissonanceCalculator, and correct the TreeCredibleLevel parameters: ccdType defaults to CCD0, numsamples to 100000, plus the required out parameter and the quiet flag.
Add CCDToolUtil.printCitations and @citation annotations to the six applauncher tools. Output goes to stderr so it does not interfere with results written to stdout, and respects the quiet/verbose flags. Also corrects DissonanceCalculator's app title, which read "Entropy Calculator".
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
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.
TreeCredibleLevelandDissonanceCalculatorwere registered asBEASTInterfaceservice providers inversion.xmlbut had no<packageapp>entry, which is the list applauncher builds its command set from. Both are now launchable:Reported by a user who could run
SkeletonAnalysisbut notTreeCredibleLevel.Changes
Registration — adds the two missing
<packageapp>entries.README — a tool's heading depth previously depended on whether it happened to fall inside the "Phylogenetic Entropy, Rogue & Skeleton Analysis" group:
EntropyCalculatorsat at####whileTreeCredibleLevelsat at###as a sibling of the group. All applauncher tools now sit at the same level under a singleAppLauncher Toolsheading, andDissonanceCalculatorgains a section.The credible-level parameters were also wrong:
ccdTypewas documented as defaulting toCCD1(code saysCCD0),numsamplesas10000(code says100000), and the requiredoutparameter andquietflag were undocumented.Citations — the
@Citationannotations already in the package are only printed because TreeAnnotator explicitly callsgetCitations();beastfx.app.tools.Applicationnever does, so no applauncher tool printed a reference. AddsCCDToolUtil.printCitationsplus annotations on all six tools, mapping each to its paper. Output goes toLog.warning(stderr) so it cannot corrupt results piped from stdout, and honours each tool's existingquiet/verboseflag.Dependency — beast
2.8.0-beta7→2.8.0-beta8.Testing
mvn verifypasses (104 tests, 0 failures).EntropyCalculatorandTreeCredibleLevelwere run end to end against a small tree set to confirm the citation prints, that-quiet truesuppresses it, and that redirecting stderr leaves stdout clean.Not addressed
SubtreeMarginalhas anApplicationmain but is registered nowhere and is undocumented.1.2.0; the pom is1.2.1-SNAPSHOT, and the release zip builds asCCD.v1.2.1-SNAPSHOT.zip. Both want resolving before a CBAN release.CCDSamplercites only the CCD point-estimate paper, though it also accepts theKRegCCD/RegCCDtypes;@Citationis static so it cannot vary withccdType.