File: index.rst

package info (click to toggle)
python-cogent 2024.5.7a1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 74,600 kB
  • sloc: python: 92,479; makefile: 117; sh: 16
file content (131 lines) | stat: -rw-r--r-- 2,893 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
###
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
    __init__/cogent3.__init__.load_annotations
    __init__/cogent3.__init__.open_data_store
    __init__/cogent3.__init__.open_
    
    

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
    annotation/annotation
    annotation_db/annotation_db
    sequence/sequence
    genetic_code/genetic_code
    moltype/moltype
    alphabet/alphabet
    table/table
    tree/tree

***************
Composable Apps
***************

.. toctree::
    :maxdepth: 1

    app/composable/define_app

*********
Datastore
*********

.. toctree::
    :maxdepth: 1

    app/io/classes/cogent3.app.io.register_datastore_reader
    app/data_store/classes/cogent3.app.data_store.DataMember
    app/data_store/classes/cogent3.app.data_store.DataStoreDirectory
    app/data_store/classes/cogent3.app.data_store.ReadOnlyDataStoreZipped
    app/sqlite_data_store/classes/cogent3.app.sqlite_data_store.DataStoreSqlite
    
*************
Deserialising
*************

.. toctree::
    :maxdepth: 1

    util/deserialise/deserialise_object    
    util/deserialise/classes/cogent3.util.deserialise.register_deserialiser