Skip to content

Commit

Permalink
docs: add warning for writing new workflow steps (#400)
Browse files Browse the repository at this point in the history
  • Loading branch information
xiamaz authored Sep 13, 2023
1 parent 4fd0c73 commit ac1a34f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/dev_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,9 @@ Usually, you define a :class:`BaseStep <snappy_pipeline.workflows.abstract.BaseS
The current configuration is passed into the constructor of this class and it then "takes over" and applies default setting, generating cluster resource settings, etc.
Then, you pass the result of method calls to your :class:`BaseStep <snappy_pipeline.workflows.abstract.BaseStep>` instance as the values for the ``input:``, ``output:``, etc. sections of your ``Snakefile``.

.. warning::
By convention your new Workflow step should be instantiated as ``wf = StepClass(...)`` in the ``Snakefile`` during object setup. Otherwise tools including cubi-tk might not be able to detect and parse your step. See existing workflow ``Snakefile`` for reference.

The :class:`BaseStep <snappy_pipeline.workflows.abstract.BaseStep>` sub class itself uses :class:`BaseStepPart <snappy_pipeline.workflows.abstract.BaseStepPart>` sub classes for the implementation of the individual parts.
One part might be linking in FASTQ files from the raw input directory or linking from the ``work/`` to the ``output/`` directory.
Another part might be the somatic variant calling using mutect or WGS SV calling using Delly2.
Expand Down

0 comments on commit ac1a34f

Please sign in to comment.