Skip to content

Commit a5f1379

Browse files
Improve operator summary (#5880)
Signed-off-by: Ben Sherman <[email protected]> Co-authored-by: Chris Hakkaart <[email protected]>
1 parent 9c554de commit a5f1379

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

docs/channel.md

+13-19
Original file line numberDiff line numberDiff line change
@@ -80,33 +80,27 @@ See {ref}`channel-factory` for the full list of channel factories.
8080

8181
## Operators
8282

83-
Operators are methods that consume and produce channels. Because channels are asynchronous, operators are necessary to manipulate the values in a channel, without using a process. As a result, operators are useful for implementing the "glue logic" between processes.
83+
Channel operators, or _operators_ for short, are functions that consume and produce channels. Because channels are asynchronous, operators are necessary to manipulate the values in a channel, aside from using a process. As a result, operators are useful for implementing the _glue logic_ between processes.
8484

85-
See {ref}`operator-page` for the full list of operators. If you are new to Nextflow, here are some commonly-used operators to learn first:
85+
Commonly used operators include:
8686

87-
Filtering:
87+
- {ref}`operator-combine`: emit the combinations of two channels
8888

89-
- {ref}`operator-filter`: select all values in a channel that satisfy a condition
90-
- {ref}`operator-first`: select the first value in a channel
91-
- {ref}`operator-take`: select the first *n* values in a channel
92-
- {ref}`operator-unique`: select the unique values in a channel (i.e. remove duplicates)
89+
- {ref}`operator-collect`: collect the values from a channel into a list
9390

94-
Transforming:
91+
- {ref}`operator-filter`: select the values in a channel that satisfy a condition
9592

96-
- {ref}`operator-collect`: collect the values from a channel into a list
97-
- {ref}`operator-grouptuple`: group the values from a channel based on a grouping key
98-
- {ref}`operator-map`: transform each value from a channel with a mapping function
99-
- {ref}`operator-reduce`: accumulate each value from a channel into a single value
93+
- {ref}`operator-flatMap`: transform each value from a channel into a list and emit each list
94+
element separately
10095

101-
Combining multiple channels:
96+
- {ref}`operator-grouptuple`: group the values from a channel based on a grouping key
10297

103-
- {ref}`operator-combine`: emit the combinations of two channels
104-
- {ref}`operator-concat`: emit the values from multiple channels (in the order in which the channels were given)
10598
- {ref}`operator-join`: join the values from two channels based on a matching key
106-
- {ref}`operator-mix`: emit the values from multiple channels (in the order in which items arrive)
10799

108-
Miscellaneous:
100+
- {ref}`operator-map`: transform each value from a channel with a mapping function
101+
102+
- {ref}`operator-mix`: emit the values from multiple channels
109103

110-
- {ref}`operator-ifempty`: emit a channel, or a default value if the channel is empty
111-
- {ref}`operator-set`: assign a channel to a variable
112104
- {ref}`operator-view`: print each value in a channel to standard output
105+
106+
See {ref}`operator-page` for the full list of operators.

0 commit comments

Comments
 (0)