matsen / pplacer

Phylogenetic placement and downstream analysis
http://matsen.fredhutch.org/pplacer/
GNU General Public License v3.0
75 stars 18 forks source link

Add `guppy fpd` #210

Closed cmccoy closed 12 years ago

cmccoy commented 12 years ago

Merge wpd, pd, and entropy into a single subcommand: guppy fpd

guppy fpd should be similar to guppy entropy, with a few modifications:

matsen commented 12 years ago

Sounds good. I like the use of --exponents. Let's try to avoid the word "alpha" for the exponent parameter as much as possible, and certainly in the documentation. "exponenent" is the appropriate replacement.

In addition, it would also be nice to have a --pendant flag. The idea is to make the same calculations as if the masses were attached via pendant branch lengths.

This doesn't require a tree traversal, so I think it's best done in a second pass through the placements. Simply sum the pendant branch length times the transform of the fractional mass for each placement. Transform here is the entropy function, quadratic entropy, etc.

matsen commented 12 years ago

A paragraph for docs:

Warning: using the --pendant branch length flag is not the same as running the equivalent analysis with a fully resolved tree. For example, two sequences that are sister in the fully resolved tree should get placed next to each other, but their common ancestry will not get factored into the analysis.

matsen commented 12 years ago

I changed my mind about the --exponent thing. I think that we should call the exponent kappa and should use the --kappa flag.