/doc/task.rst

  1.. include:: global.inc
  2#####################
  3ruffus.Task
  4#####################
  5
  6.. automodule:: ruffus.task
  7      :undoc-members:
  8      :noindex:
  9
 10***************************************
 11Decorators
 12***************************************
 13    Basic Task decorators are:
 14    
 15        :ref:`@follows() <decorators.follows>`      
 16        
 17        and
 18        
 19        :ref:`@files() <decorators.files>`      
 20        
 21    Task decorators include:
 22    
 23        :ref:`@split() <decorators.files>`      
 24
 25        :ref:`@transform() <decorators.files>`      
 26
 27        :ref:`@merge() <decorators.files>`      
 28
 29        :ref:`@posttask() <decorators.posttask>`      
 30
 31    More advanced users may require:
 32    
 33        :ref:`@transform() <decorators.transform_ex>`      
 34        
 35        :ref:`@collate() <decorators.collate>`      
 36
 37        :ref:`@parallel() <decorators.parallel>`      
 38        
 39        :ref:`@check_if_uptodate() <decorators.check_if_uptodate>`      
 40
 41        :ref:`@files_re() <decorators.files_re>`      
 42        
 43
 44***************************************
 45Pipeline functions
 46***************************************
 47========================
 48pipeline_run
 49========================
 50.. autofunction:: pipeline_run (target_tasks, forcedtorun_tasks=[], multiprocess=1, logger=stderr_logger, gnu_make_maximal_rebuild_mode=True)
 51
 52========================
 53pipeline_printout
 54========================
 55.. autofunction:: pipeline_printout
 56
 57========================
 58pipeline_printout_graph
 59========================
 60.. autofunction:: pipeline_printout_graph
 61
 62
 63.. ???
 64    
 65
 66***************************************
 67Logging
 68***************************************
 69.. autoclass:: t_black_hole_logger
 70.. autoclass:: t_stderr_logger
 71
 72.. ???
 73
 74
 75***************************************
 76Implementation:
 77***************************************
 78=================================
 79Parameter factories:
 80=================================
 81.. autofunction:: merge_param_factory
 82.. autofunction:: collate_param_factory
 83.. autofunction:: files_re_param_factory                                                                        
 84.. autofunction:: transform_param_factory
 85.. autofunction:: files_param_factory
 86.. autofunction:: args_param_factory
 87.. autofunction:: split_param_factory
 88
 89.. ???
 90    
 91    
 92=================================
 93Wrappers around jobs:
 94=================================
 95.. autofunction:: job_wrapper_generic
 96.. autofunction:: job_wrapper_io_files
 97.. autofunction:: job_wrapper_mkdir
 98
 99.. ???
100    
101
102
103
104=================================
105Checking if job is update:
106=================================
107.. autofunction:: needs_update_check_modify_time
108.. autofunction:: needs_update_check_directory_missing
109
110.. ???
111
112
113***************************************
114Exceptions and Errors
115***************************************
116.. autoclass::task_FilesArgumentsError
117.. autoclass::task_FilesreArgumentsError
118.. autoclass::JobSignalledBreak
119.. autoclass::MissingInputFileError
120.. autoclass::PostTaskArgumentError
121.. autoclass::error_making_directory
122.. autoclass::error_duplicate_task_name
123.. autoclass::error_decorator_args
124.. autoclass::error_task_name_lookup_failed
125.. autoclass::error_task_decorator_takes_no_args
126.. autoclass::error_function_is_not_a_task
127.. autoclass::error_circular_dependencies
128.. autoclass::error_not_a_directory
129.. autoclass::error_missing_output
130.. autoclass::error_job_signalled_interrupt
131
132
133
134.. ???
135
136
137
138
139