Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
qiyunzhu committed Aug 30, 2024
1 parent b76ca24 commit e89ea2e
Show file tree
Hide file tree
Showing 42 changed files with 92 additions and 83 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.accumulate_to_ancestor<a class="headerlink" href="#skbio-tree-treenode-accumulate-to-ancestor" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.accumulate_to_ancestor">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">accumulate_to_ancestor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ancestor</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3205"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.accumulate_to_ancestor" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">accumulate_to_ancestor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ancestor</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3212"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.accumulate_to_ancestor" title="Link to this definition">#</a></dt>
<dd><p>Calculate the distance between self and an ancestor.</p>
<p>The distance is the sum of branch lengths connecting the current node and the
given ancestral node.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/generated/skbio.tree.TreeNode.ascii_art.html
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.ascii_art<a class="headerlink" href="#skbio-tree-treenode-ascii-art" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.ascii_art">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">ascii_art</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_internal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L4452"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.ascii_art" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">ascii_art</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">show_internal</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compact</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L4462"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.ascii_art" title="Link to this definition">#</a></dt>
<dd><p>Return a string containing an ascii drawing of the tree.</p>
<p>Note, this method calls a private recursive function and is not safe
for large trees.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/generated/skbio.tree.TreeNode.assign_ids.html
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.assign_ids<a class="headerlink" href="#skbio-tree-treenode-assign-ids" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.assign_ids">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">assign_ids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L4068"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.assign_ids" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">assign_ids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L4078"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.assign_ids" title="Link to this definition">#</a></dt>
<dd><p>Assign topologically stable unique IDs to all nodes of the tree.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.assign_supports<a class="headerlink" href="#skbio-tree-treenode-assign-supports" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.assign_supports">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">assign_supports</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3068"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.assign_supports" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">assign_supports</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3075"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.assign_supports" title="Link to this definition">#</a></dt>
<dd><p>Extract support values from internal node labels of a tree.</p>
<p class="rubric">Notes</p>
<p>A “support value” measures the confidence or frequency of the incoming
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/generated/skbio.tree.TreeNode.cache_attr.html
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.cache_attr<a class="headerlink" href="#skbio-tree-treenode-cache-attr" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.cache_attr">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">cache_attr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_attrname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_type=&lt;class</span> <span class="pre">'list'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">register=True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3917"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.cache_attr" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">cache_attr</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_attrname</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_type=&lt;class</span> <span class="pre">'list'&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">register=True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3927"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.cache_attr" title="Link to this definition">#</a></dt>
<dd><p>Cache attributes on nodes of the tree through a postorder traversal.</p>
<dl class="field-list">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/generated/skbio.tree.TreeNode.clear_caches.html
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.clear_caches<a class="headerlink" href="#skbio-tree-treenode-clear-caches" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.clear_caches">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">clear_caches</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3844"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.clear_caches" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">clear_caches</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lookup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3854"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.clear_caches" title="Link to this definition">#</a></dt>
<dd><p>Delete node attribute and lookup caches of a tree.</p>
<div class="versionchanged">
<p><span class="versionmodified changed">Changed in version 0.6.3: </span>Renamed from <code class="docutils literal notranslate"><span class="pre">invalidate_caches</span></code>. The old name is preserved as an alias.
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/generated/skbio.tree.TreeNode.compare_rfd.html
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.compare_rfd<a class="headerlink" href="#skbio-tree-treenode-compare-rfd" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.compare_rfd">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">compare_rfd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proportion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3582"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.compare_rfd" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">compare_rfd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">proportion</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3589"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.compare_rfd" title="Link to this definition">#</a></dt>
<dd><p>Calculate the Robinson and Foulds symmetric difference.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -769,7 +769,7 @@
<h1>skbio.tree.TreeNode.compare_subsets<a class="headerlink" href="#skbio-tree-treenode-compare-subsets" title="Link to this heading">#</a></h1>
<dl class="py method">
<dt class="sig sig-object py" id="skbio.tree.TreeNode.compare_subsets">
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">compare_subsets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_absent_taxa</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3653"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.compare_subsets" title="Link to this definition">#</a></dt>
<span class="sig-prename descclassname"><span class="pre">TreeNode.</span></span><span class="sig-name descname"><span class="pre">compare_subsets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_absent_taxa</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/scikit-bio/scikit-bio/blob/main/skbio/tree/_tree.py#L3660"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#skbio.tree.TreeNode.compare_subsets" title="Link to this definition">#</a></dt>
<dd><p>Return fraction of overlapping subsets where self and other differ.</p>
<p>Names present in only one of the two trees will count as mismatches,
if you don’t want this behavior, strip out the non-matching tips first.</p>
Expand Down
Loading

0 comments on commit e89ea2e

Please sign in to comment.