Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
index.rst 3.05 KB
Newer Older
Martin Larralde's avatar
Add configuration files to build documentation with Sphinx  
Martin Larralde committed
1
2
3 
API Reference
==============
Martin Larralde's avatar
Add all Cython classes to the documentation and improve some docstrings    
Martin Larralde committed
4
5
6 
.. toctree::
   :hidden:
Martin Larralde's avatar
Improve index page in HTML documentation and update active-site example    
Martin Larralde committed
7 
   hmmer <hmmer>
Martin Larralde's avatar
Add all Cython classes to the documentation and improve some docstrings    
Martin Larralde committed
8
9 
   easel <easel>
   plan7 <plan7>
Martin Larralde's avatar
Fix `pyhmmer.daemon` appearing twice in the API reference    
Martin Larralde committed
10 
   daemon <daemon>
Martin Larralde's avatar
Improve index page in HTML documentation and update active-site example    
Martin Larralde committed
11 
   errors <errors>
Martin Larralde's avatar
Add all Cython classes to the documentation and improve some docstrings    
Martin Larralde committed
12
13
Martin Larralde's avatar
Add configuration files to build documentation with Sphinx  
Martin Larralde committed
14
15
16
17
18 
.. currentmodule:: pyhmmer

.. automodule:: pyhmmer
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
19
20 
.. only:: html
Martin Larralde's avatar
Add documentation to the `pyhmmer.hmmer` method    
Martin Larralde committed
21
22
23
24
25
26
27
28 
    HMMER
    -----

    .. autosummary::
        :nosignatures:

        pyhmmer.hmmer.hmmsearch
        pyhmmer.hmmer.phmmer
Martin Larralde's avatar
Add `pyhmmer.hmmer.nhmmer` method to search nucleic sequences    
Martin Larralde committed
29 
        pyhmmer.hmmer.nhmmer
Martin Larralde's avatar
Add documentation to the `pyhmmer.hmmer` method    
Martin Larralde committed
30 
        pyhmmer.hmmer.hmmpress
Martin Larralde's avatar
Add missing documentation for `hmmalign` function in the API docs    
Martin Larralde committed
31 
        pyhmmer.hmmer.hmmalign
Martin Larralde's avatar
Add documentation to the `pyhmmer.hmmer` method    
Martin Larralde committed
32
33
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
34
35
36 
    Easel
    -----
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
37
38
39 
    Data Structures
    ^^^^^^^^^^^^^^^
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
40
41
42
43
44 
    .. autosummary::
       :nosignatures:

       pyhmmer.easel.Bitfield
       pyhmmer.easel.KeyHash
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
45
46
47
48
49
50
51 

    Sequences
    ^^^^^^^^^

    .. autosummary::
       :nosignatures:
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
52 
       pyhmmer.easel.Sequence
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
53
54 
       pyhmmer.easel.TextSequence
       pyhmmer.easel.DigitalSequence
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
55 
       pyhmmer.easel.SequenceFile
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
56
57
58
59
60
61
62
63
64 


    Alignments
    ^^^^^^^^^^

    .. autosummary::
       :nosignatures:

       pyhmmer.easel.MSA
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
65 
       pyhmmer.easel.TextMSA
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
66
67
68
69
70
71
72
73
74
75 
       pyhmmer.easel.DigitalMSA
       pyhmmer.easel.MSAFile


    Linear Algebra
    ^^^^^^^^^^^^^^

    .. autosummary::
       :nosignatures:
Martin Larralde's avatar
Update documentation to export new `Vector` and `Matrix` classes    
Martin Larralde committed
76
77 
       pyhmmer.easel.Vector
       pyhmmer.easel.VectorF
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
78
79
80
81
82
83
84
85
86
87
88
89
90 
       pyhmmer.easel.VectorU8
       pyhmmer.easel.Matrix
       pyhmmer.easel.MatrixF
       pyhmmer.easel.MatrixU8


    Miscellaneous
    ^^^^^^^^^^^^^

    .. autosummary::
       :nosignatures:

       pyhmmer.easel.Alphabet
Martin Larralde's avatar
Add `pyhmmer.easel.Randomness` to the API docs    
Martin Larralde committed
91 
       pyhmmer.easel.Randomness
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
92
93
94 
       pyhmmer.easel.SSIReader
       pyhmmer.easel.SSIWriter
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
95
96
97
98
99 


    Plan7
    -----
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
100
101
102 
    Hidden Markov Model
    ^^^^^^^^^^^^^^^^^^^
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
103
104
105
106
107 
    .. autosummary::
        :nosignatures:

        pyhmmer.plan7.HMM
        pyhmmer.plan7.HMMFile
Martin Larralde's avatar
Fix remaining small issues in documentation    
Martin Larralde committed
108 
        pyhmmer.plan7.HMMPressedFile
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
109
110
111
112
113
114
115
116
117 


    Profile
    ^^^^^^^

    .. autosummary::
        :nosignatures:

        pyhmmer.plan7.Profile
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
118 
        pyhmmer.plan7.OptimizedProfile
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
119
120
121
122
123
124
125
126
127 
        pyhmmer.plan7.Background


    Pipelines
    ^^^^^^^^^

    .. autosummary::
        :nosignatures:
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
128 
        pyhmmer.plan7.Pipeline
Martin Larralde's avatar
Update documentation to include `LongTargetsPipeline` [ci skip]    
Martin Larralde committed
129 
        pyhmmer.plan7.LongTargetsPipeline
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
130
131
132
133
134
135
136
137
138 
        pyhmmer.plan7.Builder


    Results
    ^^^^^^^

    .. autosummary::
        :nosignatures:
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
139 
        pyhmmer.plan7.TopHits
Martin Larralde's avatar
Reorganize API documentation using subsections for each module    
Martin Larralde committed
140
141
142
143 
        pyhmmer.plan7.Hit
        pyhmmer.plan7.Domains
        pyhmmer.plan7.Domain
        pyhmmer.plan7.Alignment
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
144
145
Martin Larralde's avatar
Add several classes to `pyhmmer.plan7` to report tracebacks for HMM/sequence alignment    
Martin Larralde committed
146
147
148
149
150
151
152
153
154
155
156 
    Traces
    ^^^^^^^

    .. autosummary::
        :nosignatures:

        pyhmmer.plan7.TraceAligner
        pyhmmer.plan7.Traces
        pyhmmer.plan7.Trace
Martin Larralde's avatar
Add `plan7.IterativeSearch` and `plan7.SearchIteration` to the documentation    
Martin Larralde committed
157
158
159
160
161
162
163 
    Iterative Searches
    ^^^^^^^^^^^^^^^^^^

    .. autosummary::
       :nosignatures:

       pyhmmer.plan7.IterativeSearch
Martin Larralde's avatar
Rename `SearchIteration` to `IterationResult` for consistency    
Martin Larralde committed
164 
       pyhmmer.plan7.IterationResult
Martin Larralde's avatar
Add `plan7.IterativeSearch` and `plan7.SearchIteration` to the documentation    
Martin Larralde committed
165
166
Martin Larralde's avatar
Make `Offsets`, `Cutoffs` and `EvalueParameters` public types of `plan7`    
Martin Larralde committed
167
168
169
170
171
172
173
174
175 
    Miscellaneous
    ^^^^^^^^^^^^^

    .. autosummary::
        :nosignatures:

        pyhmmer.plan7.Cutoffs
        pyhmmer.plan7.EvalueParameters
        pyhmmer.plan7.Offsets
Martin Larralde's avatar
Update documentation in preparation for next release    
Martin Larralde committed
176 
        pyhmmer.plan7.PipelineSearchTargets
Martin Larralde's avatar
Make `Offsets`, `Cutoffs` and `EvalueParameters` public types of `plan7`    
Martin Larralde committed
177
178
Martin Larralde's avatar
Fix `pyhmmer.daemon` appearing twice in the API reference    
Martin Larralde committed
179 
    Daemon
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
180
181
182 
    ------

    .. autosummary::
Martin Larralde's avatar
Fix `pyhmmer.daemon` appearing twice in the API reference    
Martin Larralde committed
183 
        :nosignatures:
Martin Larralde's avatar
Attempt fixing API reference in PDF version of the docs [ci skip]    
Martin Larralde committed
184
Martin Larralde's avatar
Fix `pyhmmer.daemon` appearing twice in the API reference    
Martin Larralde committed
185
186 
        pyhmmer.daemon.Client
        pyhmmer.daemon.IterativeSearch
Martin Larralde's avatar
Add `plan7.IterativeSearch` and `plan7.SearchIteration` to the documentation    
Martin Larralde committed
187
188
Martin Larralde's avatar
Fix `pyhmmer.daemon` appearing twice in the API reference    
Martin Larralde committed
189 
    Errors
Martin Larralde's avatar
Add `plan7.IterativeSearch` and `plan7.SearchIteration` to the documentation    
Martin Larralde committed
190
191
192 
    ------

    .. autosummary::
Martin Larralde's avatar
Fix `pyhmmer.daemon` appearing twice in the API reference    
Martin Larralde committed
193 
       :nosignatures:
Martin Larralde's avatar
Add `plan7.IterativeSearch` and `plan7.SearchIteration` to the documentation    
Martin Larralde committed
194
Martin Larralde's avatar
Fix `pyhmmer.daemon` appearing twice in the API reference    
Martin Larralde committed
195
196
197 
       pyhmmer.errors.AllocationError
       pyhmmer.errors.UnexpectedError
       pyhmmer.errors.EaselError