You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Contributions to the code are even more welcome ;)
16
16
If you'd like to write some code for nf-core/eager, the standard workflow is as follows:
17
17
18
18
1. Check that there isn't already an issue about your idea in the [nf-core/eager issues](https://github.com/nf-core/eager/issues) to avoid duplicating work
19
-
* If there isn't one already, please create one so that others know you're working on this
19
+
- If there isn't one already, please create one so that others know you're working on this
20
20
2.[Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/eager repository](https://github.com/nf-core/eager) to your GitHub account
21
21
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
22
22
4. Use `nf-core schema build .` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
@@ -49,9 +49,9 @@ These tests are run both with the latest available version of `Nextflow` and als
49
49
50
50
:warning: Only in the unlikely and regretful event of a release happening with a bug.
51
51
52
-
* On your own fork, make a new branch `patch` based on `upstream/master`.
53
-
* Fix the bug, and bump version (X.Y.Z+1).
54
-
* A PR should be made on `master` from patch to directly this particular bug.
52
+
- On your own fork, make a new branch `patch` based on `upstream/master`.
53
+
- Fix the bug, and bump version (X.Y.Z+1).
54
+
- A PR should be made on `master` from patch to directly this particular bug.
55
55
56
56
## Getting help
57
57
@@ -96,9 +96,9 @@ The process resources can be passed on to the tool dynamically within the proces
96
96
97
97
Please use the following naming schemes, to make it easy to understand what is going where.
98
98
99
-
* initial process channel: `ch_output_from_<process>`
100
-
* intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
101
-
* skipped process output: `ch_<previousstage>_for_<skipprocess>`(this goes out of the bypass statement described above)
99
+
- initial process channel: `ch_output_from_<process>`
100
+
- intermediate and terminal channels: `ch_<previousprocess>_for_<nextprocess>`
101
+
- skipped process output: `ch_<previousstage>_for_<skipprocess>`(this goes out of the bypass statement described above)
102
102
103
103
### Nextflow version bumping
104
104
@@ -135,35 +135,35 @@ For all internal nf-core/eager documentation images we are using the 'Kalam' fon
135
135
136
136
We are providing a highly configurable pipeline, with many options to turn on and off different processes in different combinations. This can make a very complex graph structure that can cause a large amount of duplicated channels coming out of every process to account for each possible combination.
137
137
138
-
The EAGER pipeline can currently be broken down into the following 'stages', where a stage is a collection of non-terminal mutually exclusive processes, which is the output of which is used for another file reporting module (but not reporting!) .
138
+
The EAGER pipeline can currently be broken down into the following 'stages', where a stage is a collection of non-terminal mutually exclusive processes, which is the output of which is used for another file reporting module (but not reporting!) .
139
139
140
-
* Input
141
-
* Convert BAM
142
-
* PolyG Clipping
143
-
* AdapterRemoval
144
-
* Mapping (either `bwa`, `bwamem`, or `circularmapper`)
145
-
* BAM Filtering
146
-
* Deduplication (either `dedup` or `markduplicates`)
147
-
* BAM Trimming
148
-
* PMDtools
149
-
* Genotyping
140
+
- Input
141
+
- Convert BAM
142
+
- PolyG Clipping
143
+
- AdapterRemoval
144
+
- Mapping (either `bwa`, `bwamem`, or `circularmapper`)
145
+
- BAM Filtering
146
+
- Deduplication (either `dedup` or `markduplicates`)
147
+
- BAM Trimming
148
+
- PMDtools
149
+
- Genotyping
150
150
151
151
Every step can potentially be skipped, therefore the output of a previous stage must be able to be passed to the next stage, if the given stage is not run.
152
152
153
153
To somewhat simplify this logic, we have implemented the following structure.
154
154
155
155
The concept is as follows:
156
156
157
-
* Every 'stage' of the pipeline (i.e. collection of mutually exclusive processes) must always have a if else statement following it.
158
-
* This if else 'bypass' statement collects and standardises all possible input files into single channel(s) for the next stage.
159
-
* Importantly - within the bypass statement, a channel from the previous stage's bypass mixes into these output channels. This additional channel is named `ch_previousstage_for_skipcurrentstage`. This contains the output from the previous stage, i.e. not the modified version from the current stage.
160
-
* The bypass statement works as follows:
161
-
* If the current stage is turned on: will mix the previous stage and current stage output and filter for file suffixes unique to the current stage output
162
-
* If the current stage is turned off or skipped: will mix the previous stage and current stage output. However as there there is no files in the output channel from the current stage, no filtering is required and the files in the 'ch_XXX_for_skipXXX' stage will be used.
163
-
164
-
This ensures the same channel inputs to the next stage is 'homogeneous' - i.e. all comes from the same source (the bypass statement)
165
-
166
-
An example schematic can be given as follows
157
+
- Every 'stage' of the pipeline (i.e. collection of mutually exclusive processes) must always have a if else statement following it.
158
+
- This if else 'bypass' statement collects and standardises all possible input files into single channel(s) for the next stage.
159
+
- Importantly - within the bypass statement, a channel from the previous stage's bypass mixes into these output channels. This additional channel is named `ch_previousstage_for_skipcurrentstage`. This contains the output from the previous stage, i.e. not the modified version from the current stage.
160
+
- The bypass statement works as follows:
161
+
- If the current stage is turned on: will mix the previous stage and current stage output and filter for file suffixes unique to the current stage output
162
+
- If the current stage is turned off or skipped: will mix the previous stage and current stage output. However as there there is no files in the output channel from the current stage, no filtering is required and the files in the 'ch_XXX_for_skipXXX' stage will be used.
163
+
164
+
This ensures the same channel inputs to the next stage is 'homogeneous' - i.e. all comes from the same source (the bypass statement)
- nf-core/eager FAQ/troubleshooting can be found [here](https://nf-co.re/eager/usage#troubleshooting-and-faqs)
21
+
-[ ][nf-core/eager pipeline documentation](https://nf-co.re/nf-core/eager/usage) - nf-core/eager FAQ/troubleshooting can be found [here](https://nf-co.re/eager/usage#troubleshooting-and-faqs)
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,9 +16,9 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/eage
16
16
17
17
-[ ] This comment contains a description of changes (with reason).
18
18
-[ ] If you've fixed a bug or added code that should be tested, add tests!
19
-
-[ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
20
-
-[ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](<https://github.com/>nf-core/eager/tree/master/.github/CONTRIBUTING.md)
21
-
-[ ] If necessary, also make a PR on the nf-core/eager _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
19
+
-[ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
20
+
-[ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](<https://github.com/>nf-core/eager/tree/master/.github/CONTRIBUTING.md)
21
+
-[ ] If necessary, also make a PR on the nf-core/eager _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
22
22
-[ ] Make sure your code lints (`nf-core lint .`).
23
23
-[ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
24
24
-[ ] Usage Documentation in `docs/usage.md` is updated.
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@ Please fill in the appropriate checklist below (delete whatever is not relevant)
4
4
5
5
## PR checklist
6
6
7
-
-[ ] This comment contains a description of changes (with reason).
8
-
-[ ] If you've fixed a bug or added code that should be tested, add tests!
9
-
-[ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
10
-
-[ ] If necessary, also make a PR on the [nf-core/eager branch on the nf-core/test-datasets repo](https://github.com/nf-core/test-datasets/pull/new/nf-core/eager).
11
-
-[ ] Make sure your code lints (`nf-core lint .`).
12
-
-[ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
13
-
-[ ] Usage Documentation in `docs/usage.md` is updated.
14
-
-[ ] Output Documentation in `docs/output.md` is updated.
15
-
-[ ]`CHANGELOG.md` is updated.
16
-
-[ ]`README.md` is updated (including new tool citations and authors/contributors).
7
+
-[ ] This comment contains a description of changes (with reason).
8
+
-[ ] If you've fixed a bug or added code that should be tested, add tests!
9
+
-[ ] If you've added a new tool - add to the software_versions process and a regex to `scrape_software_versions.py`
10
+
-[ ] If necessary, also make a PR on the [nf-core/eager branch on the nf-core/test-datasets repo](https://github.com/nf-core/test-datasets/pull/new/nf-core/eager).
11
+
-[ ] Make sure your code lints (`nf-core lint .`).
12
+
-[ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
13
+
-[ ] Usage Documentation in `docs/usage.md` is updated.
14
+
-[ ] Output Documentation in `docs/output.md` is updated.
15
+
-[ ]`CHANGELOG.md` is updated.
16
+
-[ ]`README.md` is updated (including new tool citations and authors/contributors).
17
17
18
18
**Learn more about contributing:**https://github.com/nf-core/eager/tree/master/.github/CONTRIBUTING.md
0 commit comments