File: contents.rst

package info (click to toggle)
python-ruffus 2.6.3%2Bdfsg-4~bpo8%2B1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-backports
  • size: 20,828 kB
  • sloc: python: 15,745; makefile: 180; sh: 14
file content (200 lines) | stat: -rw-r--r-- 4,885 bytes parent folder | download | duplicates (2)
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
.. include:: global.inc
***************************
**Ruffus** documentation
***************************
==========================================
Start Here:
==========================================
.. toctree::
   :maxdepth: 2

   installation.rst
   tutorials/new_tutorial/manual_contents.rst
   tutorials/new_tutorial/introduction.rst
   tutorials/new_tutorial/transform.rst
   tutorials/new_tutorial/transform_in_parallel.rst
   tutorials/new_tutorial/originate.rst
   tutorials/new_tutorial/pipeline_printout.rst
   tutorials/new_tutorial/command_line.rst
   tutorials/new_tutorial/pipeline_printout_graph.rst
   tutorials/new_tutorial/output_file_names.rst
   tutorials/new_tutorial/mkdir.rst
   tutorials/new_tutorial/checkpointing.rst
   tutorials/new_tutorial/decorators_compendium.rst
   tutorials/new_tutorial/split.rst
   tutorials/new_tutorial/merge.rst
   tutorials/new_tutorial/multiprocessing.rst
   tutorials/new_tutorial/logging.rst
   tutorials/new_tutorial/subdivide_collate.rst
   tutorials/new_tutorial/combinatorics.rst
   tutorials/new_tutorial/active_if.rst
   tutorials/new_tutorial/posttask.rst
   tutorials/new_tutorial/inputs.rst
   tutorials/new_tutorial/onthefly.rst
   tutorials/new_tutorial/parallel.rst
   tutorials/new_tutorial/check_if_uptodate.rst
   tutorials/new_tutorial/flowchart_colours.rst
   tutorials/new_tutorial/dependencies.rst
   tutorials/new_tutorial/exceptions.rst
   tutorials/new_tutorial/list_of_ruffus_names.rst
   tutorials/new_tutorial/deprecated_files.rst
   tutorials/new_tutorial/deprecated_files_re.rst


Example code for:

.. toctree::
   :maxdepth: 1

   tutorials/new_tutorial/introduction_code.rst
   tutorials/new_tutorial/transform_code.rst
   tutorials/new_tutorial/transform_in_parallel_code.rst
   tutorials/new_tutorial/originate_code.rst
   tutorials/new_tutorial/pipeline_printout_code.rst
   tutorials/new_tutorial/pipeline_printout_graph_code.rst
   tutorials/new_tutorial/output_file_names_code.rst
   tutorials/new_tutorial/mkdir_code.rst
   tutorials/new_tutorial/checkpointing_code.rst
   tutorials/new_tutorial/split_code.rst
   tutorials/new_tutorial/merge_code.rst
   tutorials/new_tutorial/multiprocessing_code.rst
   tutorials/new_tutorial/logging_code.rst
   tutorials/new_tutorial/subdivide_collate_code.rst
   tutorials/new_tutorial/combinatorics_code.rst
   tutorials/new_tutorial/inputs_code.rst
   tutorials/new_tutorial/onthefly_code.rst
   tutorials/new_tutorial/flowchart_colours_code.rst



=====================
Overview:
=====================
.. toctree::
   :maxdepth: 2

   cheatsheet.rst
   pipeline_functions.rst
   drmaa_wrapper_functions.rst
   installation.rst
   design.rst
   Bugs and Updates <history>
   tutorials/new_syntax.rst
   tutorials/new_syntax_worked_example.rst
   tutorials/new_syntax_worked_example_code.rst
   Future plans <todo>
   Implementation_notes <implementation_notes.rst>
   faq.rst
   glossary.rst
   gallery.rst
   why_ruffus.rst

=====================
Examples
=====================
.. toctree::
   :maxdepth: 2

   examples/bioinformatics/index.rst
   examples/bioinformatics/part2.rst
   examples/bioinformatics/part1_code.rst
   examples/bioinformatics/part2_code.rst
   examples/paired_end_data.py.rst



=====================
Reference:
=====================
######################
Decorators
######################
.. toctree::
    :maxdepth: 1

    decorators/decorators.rst
    decorators/indicator_objects.rst


.. topic::
    Core

    .. toctree::
        :maxdepth: 1

        decorators/originate.rst
        decorators/split.rst
        decorators/transform.rst
        decorators/merge.rst

.. topic::
    For advanced users

    .. toctree::
        :maxdepth: 1

        decorators/subdivide.rst
        decorators/transform_ex.rst
        decorators/collate.rst
        decorators/collate_ex.rst
        decorators/graphviz.rst
        decorators/mkdir.rst
        decorators/jobs_limit.rst
        decorators/posttask.rst
        decorators/active_if.rst
        decorators/follows.rst

.. topic::
    Combinatorics

    .. toctree::
        :maxdepth: 1

        decorators/product.rst
        decorators/permutations.rst
        decorators/combinations.rst
        decorators/combinations_with_replacement.rst

.. topic::
    Esoteric

    .. toctree::
        :maxdepth: 1

        decorators/files_ex.rst
        decorators/check_if_uptodate.rst
        decorators/parallel.rst

.. topic::
    Deprecated

    .. toctree::
        :maxdepth: 1

        decorators/files.rst
        decorators/files_re.rst


######################
Modules:
######################

.. toctree::
   :maxdepth: 2

   task.rst
   proxy_logger.rst

.. comment
   graph.rst
   print_dependencies.rst
   adjacent_pairs_iterate.rst


=====================
Indices and tables
=====================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`