File: index.rst

package info (click to toggle)
python-cogent 2023.2.12a1%2Bdfsg-2%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 12,416 kB
  • sloc: python: 89,165; makefile: 117; sh: 16
file content (101 lines) | stat: -rw-r--r-- 2,119 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
###
API
###

*********************
Utility Functions For
*********************

Loading data from file
======================

These are all top level imports. For example,

.. code-block:: python

    from cogent3 import load_unaligned_seqs

.. toctree::
    :maxdepth: 1

    __init__/cogent3.__init__.load_seq
    __init__/cogent3.__init__.load_aligned_seqs
    __init__/cogent3.__init__.load_unaligned_seqs
    __init__/cogent3.__init__.load_delimited
    __init__/cogent3.__init__.load_table
    __init__/cogent3.__init__.load_tree

Making cogent3 types from standard Python types
===============================================

These are all top level imports. For example,

.. code-block:: python

    from cogent3 import make_unaligned_seqs

.. toctree::
    :maxdepth: 1

    __init__/cogent3.__init__.make_seq
    __init__/cogent3.__init__.make_aligned_seqs
    __init__/cogent3.__init__.make_unaligned_seqs
    __init__/cogent3.__init__.make_table
    __init__/cogent3.__init__.make_tree

Getting commonly used cogent3 types
===================================

These are all top level imports. For example,

.. code-block:: python

    from cogent3 import get_code

.. toctree::
    :maxdepth: 1

    __init__/cogent3.__init__.get_code
    __init__/cogent3.__init__.get_moltype
    __init__/cogent3.__init__.get_model

Displaying cogent3 builtins
===========================

These are all top level imports. For example,

.. code-block:: python

    from cogent3 import get_code

.. toctree::
    :maxdepth: 1

    __init__/cogent3.__init__.available_codes
    __init__/cogent3.__init__.available_moltypes
    __init__/cogent3.__init__.available_models
    __init__/cogent3.__init__.available_apps

****************************
The Major cogent3 Data Types
****************************

.. toctree::
    :maxdepth: 1

    alignment/alignment
    sequence/sequence
    genetic_code/genetic_code
    moltype/moltype
    alphabet/alphabet
    table/table
    tree/tree

************************
Defining Composable Apps
************************

.. toctree::
    :maxdepth: 1

    apps/composable.define_app