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
|
.. include:: ../../global.inc
.. include:: manual_chapter_numbers.inc
.. _new_manual.table_of_contents:
####################################################################
**Ruffus** Manual: List of Chapters and Example code
####################################################################
Download as :download:`pdf <../../static_data/ruffus.pdf>`.
* |new_manual.introduction.chapter_num|: :ref:`An introduction to basic Ruffus syntax <new_manual.introduction>`
* |new_manual.transform.chapter_num|: :ref:`Transforming data in a pipeline with @transform <new_manual.transform>`
* |new_manual.transform_in_parallel.chapter_num|: :ref:`More on @transform-ing data <new_manual.transform_in_parallel>`
* |new_manual.originate.chapter_num|: :ref:`Creating files with @originate <new_manual.originate>`
* |new_manual.pipeline_printout.chapter_num|: :ref:`Understanding how your pipeline works with pipeline_printout() <new_manual.pipeline_printout>`
* |new_manual.cmdline.chapter_num|: :ref:`Running Ruffus from the command line with ruffus.cmdline <new_manual.cmdline>`
* |new_manual.pipeline_printout_graph.chapter_num|: :ref:`Displaying the pipeline visually with pipeline_printout_graph() <new_manual.pipeline_printout_graph>`
* |new_manual.output_file_names.chapter_num|: :ref:`Specifying output file names with formatter() and regex() <new_manual.output_file_names>`
* |new_manual.mkdir.chapter_num|: :ref:`Preparing directories for output with @mkdir <new_manual.mkdir>`
* |new_manual.checkpointing.chapter_num|: :ref:`Checkpointing: Interrupted Pipelines and Exceptions <new_manual.checkpointing>`
* |new_manual.decorators_compendium.chapter_num|: :ref:`Pipeline topologies and a compendium of Ruffus decorators <new_manual.decorators_compendium>`
* |new_manual.split.chapter_num|: :ref:`Splitting up large tasks / files with @split <new_manual.split>`
* |new_manual.merge.chapter_num|: :ref:`@merge multiple input into a single result <new_manual.merge>`
* |new_manual.logging.chapter_num|: :ref:`Logging progress through a pipeline <new_manual.logging>`
* |new_manual.multiprocessing.chapter_num|: :ref:`Multiprocessing, drmaa and Computation Clusters <new_manual.multiprocessing>`
* |new_manual.subdivide_collate.chapter_num|: :ref:`@subdivide tasks to run efficiently and regroup with @collate <new_manual.subdivide_collate>`
* |new_manual.combinatorics.chapter_num|: :ref:`@combinations, @permutations and all versus all @product <new_manual.combinatorics>`
* |new_manual.active_if.chapter_num|: :ref:`Turning parts of the pipeline on and off at runtime with @active_if <new_manual.active_if>`
* |new_manual.inputs.chapter_num|: :ref:`Manipulating task inputs via string substitution with inputs() and add_inputs() <new_manual.inputs>`
* |new_manual.posttask.chapter_num|: :ref:`Signal the completion of each stage of our pipeline with @posttask <new_manual.posttask>`
* |new_manual.on_the_fly.chapter_num|: :ref:`Esoteric: Generating parameters on the fly with @files <new_manual.on_the_fly>`
* |new_manual.parallel.chapter_num|: :ref:`Esoteric: Running jobs in parallel without files using @parallel <new_manual.deprecated_parallel>`
* |new_manual.check_if_uptodate.chapter_num|: :ref:`Esoteric: Writing custom functions to decide which jobs are up to date with @check_if_uptodate <new_manual.check_if_uptodate>`
* |new_manual.flowchart_colours.chapter_num| :ref:`Flow Chart Colours with pipeline_printout_graph <new_manual.flowchart_colours>`
* |new_manual.dependencies.chapter_num| :ref:`Under the hood: How dependency works <new_manual.dependencies>`
* |new_manual.exceptions.chapter_num| :ref:`Exceptions thrown inside pipelines <new_manual.exceptions>`
* |new_manual.ruffus_names.chapter_num| :ref:`Names (keywords) exported from Ruffus <new_manual.ruffus_names>`
* |new_manual.deprecated_files.chapter_num|: :ref:`Legacy and deprecated syntax @files <new_manual.deprecated_files>`
* |new_manual.deprecated_files_re.chapter_num|: :ref:`Legacy and deprecated syntax @files_re <new_manual.deprecated_files_re>`
**Ruffus** Manual: List of Example Code for Each Chapter:
* :ref:`new_manual.introduction.code`
* :ref:`new_manual.transform.code`
* :ref:`new_manual.transform_in_parallel.code`
* :ref:`new_manual.originate.code`
* :ref:`new_manual.pipeline_printout.code`
* :ref:`new_manual.pipeline_printout_graph.code`
* :ref:`new_manual.output_file_names.code`
* :ref:`new_manual.mkdir.code`
* :ref:`new_manual.checkpointing.code`
* :ref:`new_manual.split.code`
* :ref:`new_manual.merge.code`
* :ref:`new_manual.multiprocessing.code`
* :ref:`new_manual.logging.code`
* :ref:`new_manual.subdivide_collate.code`
* :ref:`new_manual.combinatorics.code`
* :ref:`new_manual.inputs.code`
* :ref:`new_manual.on_the_fly.code`
|
