diff --git a/docs/api.pdf b/docs/api.pdf index 4def538..ff4a717 100644 Binary files a/docs/api.pdf and b/docs/api.pdf differ diff --git a/pylogeny/__version__.py b/pylogeny/__version__.py index ace4d57..5d8b026 100644 --- a/pylogeny/__version__.py +++ b/pylogeny/__version__.py @@ -1 +1 @@ -VERSION = '0.3.6.1' +VERSION = '0.3.6.2' diff --git a/pylogeny/scoring.py b/pylogeny/scoring.py index d8423b5..b502e7a 100644 --- a/pylogeny/scoring.py +++ b/pylogeny/scoring.py @@ -21,9 +21,9 @@ def beaglegetLogLikelihood(tree,alignment): Currently uses HKY85 model. :param tree: A tree object. - :type tree: :class: `.tree.tree` + :type tree: :class:`.tree.tree` :param alignment: An alignment object. - :type alignment: :class: `.alignment.alignment` + :type alignment: :class:`.alignment.alignment` :returns: A floating point value. ''' @@ -40,12 +40,13 @@ def beaglegetLogLikelihood(tree,alignment): def getLogLikelihood(tree,alignment,updateBranchLengths=True): - ''' Acquire log-likelihood via C library libpll. + ''' Acquire log-likelihood via C library libpll. Requires the input + alignment to be "Phylip friendly" (a phylipFriendlyAlignment). :param tree: A tree object. - :type tree: :class: `.tree.tree` + :type tree: :class:`.tree.tree` :param alignment: An alignment object. - :type alignment: :class: `.alignment.phylipFriendlyAlignment` + :type alignment: :class:`.alignment.phylipFriendlyAlignment` :param updateBranchLengths: Whether or not to update the branch lengths in the provided tree with optimized ones. :returns: A floating point value. @@ -95,7 +96,7 @@ def getParsimony(newick,alignment): :param newick: A New Hampshire (Newick) tree string. :param alignment: An alignment object. - :type alignment: :class: `.alignment.alignment` + :type alignment: :class:`.alignment.alignment` :returns: An integer value. ''' @@ -108,9 +109,9 @@ def getParsimonyForTopology(topo,alignment): ''' Acquire parsimony via a C++ implementation. :param topo: A topology object. - :type topo: :class: `.rearrangement.topology` + :type topo: :class:`.rearrangement.topology` :param alignment: An alignment object. - :type alignment: :class: `.alignment.alignment` + :type alignment: :class:`.alignment.alignment` :returns: An integer value. ''' @@ -125,7 +126,7 @@ def getParsimonyFromProfiles(newick,profiles): :param newick: A New Hampshire (Newick) tree string. :param profiles: A set of profiles corresponding to an alignment. - :type profiles: :class: `.parsimony.profile_set` + :type profiles: :class:`.parsimony.profile_set` :returns: An integer value. ''' @@ -140,9 +141,9 @@ def getParsimonyFromProfilesForTopology(topology,profiles): ''' Acquire parsimony via a C++ implementation. :param topo: A topology object. - :type topo: :class: `.rearrangement.topology` + :type topo: :class:`.rearrangement.topology` :param profiles: A set of profiles corresponding to an alignment. - :type profiles: :class: `.parsimony.profile_set` + :type profiles: :class:`.parsimony.profile_set` :returns: An integer value. '''