Nextflow documentation is migrating

Nextflow documentation is being migrated to docs.seqera.io/nextflow. This site will remain available throughout the migration.

nextflow.extension

The nextflow.extension package implements the channel operators and other extension methods.

Class Diagram

        classDiagram
    %%
    %% nextflow.extension
    %%
    direction LR

    ChannelEx --> DumpOp : dump
    Nextflow --> GroupKey : groupKey

    OperatorImpl --> BranchOp : branch
    OperatorImpl --> BufferOp : buffer
    OperatorImpl --> CollectFileOp : collectFile
    OperatorImpl --> CollectOp : collect
    OperatorImpl --> CombineOp : combine
    OperatorImpl --> ConcatOp : concat
    OperatorImpl --> CrossOp : cross
    OperatorImpl --> GroupTupleOp : groupTuple
    OperatorImpl --> JoinOp : join
    OperatorImpl --> MapOp : map
    OperatorImpl --> MergeOp : merge
    OperatorImpl --> MixOp : mix
    OperatorImpl --> MultiMapOp : multiMap
    OperatorImpl --> RandomSampleOp : randomSample
    OperatorImpl --> SplitOp : splitCsv, splitFasta, splitFastq, splitText
    OperatorImpl --> TakeOp : take
    OperatorImpl --> ToListOp : toList, toSortedList
    OperatorImpl --> TransposeOp : transpose
    OperatorImpl --> UntilOp : until

    WorkflowBinding --> OpCall : invokeMethod

    

Note

Some classes may be excluded from the above diagram for brevity.

Notes

Operators are implemented using the GPars dataflow library. In general, an operator consumes one or more DataflowReadChannels and produces one or more DataflowWriteChannels. See Operators (legacy) for details about each operator.

Other notable classes include Bolts and FilesEx, which implement various extension methods used throughout the Nextflow codebase. If you see a method that doesn’t appear to be implemented by the calling object, it may be implemented in one of these extension classes.