File: TreeNode.rst

package info (click to toggle)
python-skbio 0.6.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 11,924 kB
  • sloc: python: 67,527; ansic: 672; makefile: 225
file content (149 lines) | stat: -rw-r--r-- 3,063 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
{# This template is specifically for skbio.tree.TreeNode. #}

{% extends "autosummary/class.rst" %}

   {% block methods %}

   .. rubric:: Tree IO
      
   .. autosummary::
      :toctree:

      ~{{ name }}.read
      ~{{ name }}.write

   .. rubric:: Tree navigation

   .. autosummary::
      :toctree:

      ~{{ name }}.ancestors
      ~{{ name }}.has_children
      ~{{ name }}.is_root
      ~{{ name }}.is_tip
      ~{{ name }}.lca
      ~{{ name }}.neighbors
      ~{{ name }}.path
      ~{{ name }}.root
      ~{{ name }}.siblings

   .. rubric:: Tree traversal

   .. autosummary::
      :toctree:

      ~{{ name }}.levelorder
      ~{{ name }}.non_tips
      ~{{ name }}.postorder
      ~{{ name }}.pre_and_postorder
      ~{{ name }}.preorder
      ~{{ name }}.tips
      ~{{ name }}.traverse

   .. rubric:: Tree copying

   .. autosummary::
      :toctree:

      ~{{ name }}.copy
      ~{{ name }}.deepcopy
      ~{{ name }}.subtree

   .. rubric:: Tree manipulation

   .. autosummary::
      :toctree:

      ~{{ name }}.append
      ~{{ name }}.bifurcate
      ~{{ name }}.extend
      ~{{ name }}.insert
      ~{{ name }}.pop
      ~{{ name }}.prune
      ~{{ name }}.remove
      ~{{ name }}.remove_by_func
      ~{{ name }}.remove_deleted
      ~{{ name }}.shear
      ~{{ name }}.shuffle
      ~{{ name }}.unpack
      ~{{ name }}.unpack_by_func

   .. rubric:: Tree rerooting

   .. autosummary::
      :toctree:

      ~{{ name }}.root_at
      ~{{ name }}.root_at_midpoint
      ~{{ name }}.root_by_outgroup
      ~{{ name }}.unroot
      ~{{ name }}.unrooted_copy
      ~{{ name }}.unrooted_deepcopy
      ~{{ name }}.unrooted_move

   .. rubric:: Tree searching

   .. autosummary::
      :toctree:

      ~{{ name }}.assign_ids
      ~{{ name }}.cache_attr
      ~{{ name }}.clear_caches
      ~{{ name }}.create_caches
      ~{{ name }}.has_caches
      ~{{ name }}.find
      ~{{ name }}.find_all
      ~{{ name }}.find_by_func
      ~{{ name }}.find_by_id
      ~{{ name }}.index_tree

   .. rubric:: Tree analysis

   .. autosummary::
      :toctree:

      ~{{ name }}.bipart
      ~{{ name }}.biparts
      ~{{ name }}.cophenet
      ~{{ name }}.count
      ~{{ name }}.depth
      ~{{ name }}.distance
      ~{{ name }}.height
      ~{{ name }}.is_bifurcating
      ~{{ name }}.maxdist
      ~{{ name }}.observed_node_counts
      ~{{ name }}.subset
      ~{{ name }}.subsets
      ~{{ name }}.total_length

   .. rubric:: Tree comparison

   .. autosummary::
      :toctree:

      ~{{ name }}.compare_biparts
      ~{{ name }}.compare_cophenet
      ~{{ name }}.compare_rfd
      ~{{ name }}.compare_subsets
      ~{{ name }}.compare_wrfd

   .. rubric:: Tree visualization

   .. autosummary::
      :toctree:

      ~{{ name }}.ascii_art

   .. rubric:: Format conversion

   .. autosummary::
      :toctree:

      ~{{ name }}.assign_supports
      ~{{ name }}.from_linkage_matrix
      ~{{ name }}.from_taxdump
      ~{{ name }}.from_taxonomy
      ~{{ name }}.to_array
      ~{{ name }}.to_taxonomy

   {% endblock %}