Skip to content

Commit 99046cb

Browse files
committed
prettier fixes
1 parent c6ea117 commit 99046cb

19 files changed

Lines changed: 2587 additions & 2620 deletions

.github/CONTRIBUTING.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Contributions to the code are even more welcome ;)
1616
If you'd like to write some code for nf-core/eager, the standard workflow is as follows:
1717

1818
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
2020
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
2121
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
2222
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
4949

5050
:warning: Only in the unlikely and regretful event of a release happening with a bug.
5151

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.
5555

5656
## Getting help
5757

@@ -96,9 +96,9 @@ The process resources can be passed on to the tool dynamically within the proces
9696

9797
Please use the following naming schemes, to make it easy to understand what is going where.
9898

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)
102102

103103
### Nextflow version bumping
104104

@@ -135,35 +135,35 @@ For all internal nf-core/eager documentation images we are using the 'Kalam' fon
135135

136136
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.
137137

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!) .
139139

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
150150

151151
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.
152152

153153
To somewhat simplify this logic, we have implemented the following structure.
154154

155155
The concept is as follows:
156156

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)
165+
166+
An example schematic can be given as follows
167167

168168
```nextflow
169169
// PREVIOUS STAGE OUTPUT
@@ -191,7 +191,7 @@ process fastp {
191191
192192
script:
193193
"""
194-
echo "I have been fastp'd" > ${fq}
194+
echo "I have been fastp'd" > ${fq}
195195
mv ${fq} ${fq}.pG.fq
196196
"""
197197
}
@@ -206,4 +206,4 @@ if (params.run_fastp) {
206206
.into { ch_fastp_for_adapterremoval; ch_fastp_for_skipadapterremoval }
207207
}
208208
209-
```
209+
```

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ Please delete this text and anything that's not relevant from the template below
1818
I have checked the following places for your error:
1919

2020
- [ ] [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
21-
- [ ] [nf-core/eager pipeline documentation](https://nf-co.re/nf-core/eager/usage)
22-
- 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)
2322

2423
## Description of the bug
2524

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/eage
1616

1717
- [ ] This comment contains a description of changes (with reason).
1818
- [ ] 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.
2222
- [ ] Make sure your code lints (`nf-core lint .`).
2323
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
2424
- [ ] Usage Documentation in `docs/usage.md` is updated.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ Please fill in the appropriate checklist below (delete whatever is not relevant)
44

55
## PR checklist
66

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).
1717

1818
**Learn more about contributing:** https://github.com/nf-core/eager/tree/master/.github/CONTRIBUTING.md

.github/markdownlint.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
default: true
33
line-length: false
44
no-duplicate-header:
5-
siblings_only: true
5+
siblings_only: true
66
no-inline-html:
7-
allowed_elements:
8-
- img
9-
- p
10-
- kbd
11-
- details
12-
- summary
7+
allowed_elements:
8+
- img
9+
- p
10+
- kbd
11+
- details
12+
- summary

.github/workflows/awsfulltest.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ on:
99
types: [completed]
1010
workflow_dispatch:
1111

12-
1312
env:
1413
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
1514
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -18,7 +17,6 @@ env:
1817
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }}
1918
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
2019

21-
2220
jobs:
2321
run-awstest:
2422
name: Run AWS full tests

.github/workflows/awstest.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ name: nf-core AWS test
66
on:
77
workflow_dispatch:
88

9-
109
env:
1110
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
1211
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
@@ -15,7 +14,6 @@ env:
1514
AWS_JOB_QUEUE: ${{ secrets.AWS_JOB_QUEUE }}
1615
AWS_S3_BUCKET: ${{ secrets.AWS_S3_BUCKET }}
1716

18-
1917
jobs:
2018
run-awstest:
2119
name: Run AWS tests

.github/workflows/branch.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ jobs:
1515
run: |
1616
{ [[ ${{github.event.pull_request.head.repo.full_name }} == nf-core/eager ]] && [[ $GITHUB_HEAD_REF = "dev" ]]; } || [[ $GITHUB_HEAD_REF == "patch" ]]
1717
18-
1918
# If the above check failed, post a comment on the PR explaining the failure
2019
# NOTE - this doesn't currently work if the PR is coming from a fork, due to limitations in GitHub actions secrets
2120
- name: Post PR comment
@@ -43,4 +42,3 @@ jobs:
4342
Thanks again for your contribution!
4443
repo-token: ${{ secrets.GITHUB_TOKEN }}
4544
allow-repeats: false
46-

.github/workflows/ci.yml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323
strategy:
2424
matrix:
2525
# Nextflow versions: check pipeline minimum and current latest
26-
nxf_ver: ['20.07.1', '']
26+
nxf_ver: ["20.07.1", ""]
2727
steps:
2828
- name: Check out pipeline code
2929
uses: actions/checkout@v2
@@ -58,7 +58,7 @@ jobs:
5858
run: |
5959
git clone --single-branch --branch eager https://github.com/nf-core/test-datasets.git data
6060
- name: DELAY to try address some odd behaviour with what appears to be a conflict between parallel htslib jobs leading to CI hangs
61-
run: |
61+
run: |
6262
if [[ $NXF_VER = '' ]]; then sleep 1200; fi
6363
- name: BASIC Run the basic pipeline with directly supplied single-end FASTQ
6464
run: |
@@ -74,7 +74,7 @@ jobs:
7474
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --save_reference
7575
- name: REFERENCE Basic workflow, with supplied indices
7676
run: |
77-
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --bwa_index 'results/reference_genome/bwa_index/BWAIndex/' --fasta_index 'https://github.com/nf-core/test-datasets/blob/eager/reference/Mammoth/Mammoth_MT_Krause.fasta.fai'
77+
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --bwa_index 'results/reference_genome/bwa_index/BWAIndex/' --fasta_index 'https://github.com/nf-core/test-datasets/blob/eager/reference/Mammoth/Mammoth_MT_Krause.fasta.fai'
7878
- name: REFERENCE Run the basic pipeline with FastA reference with `fna` extension
7979
run: |
8080
nextflow run ${GITHUB_WORKSPACE} -profile test_tsv_fna,docker
@@ -107,7 +107,7 @@ jobs:
107107
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --clip_adapters_list 'https://github.com/nf-core/test-datasets/raw/eager/databases/adapters/adapter-list.txt'
108108
- name: ADAPTER LIST Run the basic pipeline using an adapter list, skipping adapter removal
109109
run: |
110-
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --clip_adapters_list 'https://github.com/nf-core/test-datasets/raw/eager/databases/adapters/adapter-list.txt' --skip_adapterremoval
110+
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --clip_adapters_list 'https://github.com/nf-core/test-datasets/raw/eager/databases/adapters/adapter-list.txt' --skip_adapterremoval
111111
- name: POST_AR_FASTQ_TRIMMING Run the basic pipeline post-adapterremoval FASTQ trimming
112112
run: |
113113
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --run_post_ar_trimming
@@ -193,11 +193,11 @@ jobs:
193193
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --run_bam_filtering --bam_unmapped_type 'fastq' --run_metagenomic_screening --metagenomic_tool 'malt' --database "/home/runner/work/eager/eager/databases/malt/" --metagenomic_complexity_filter
194194
- name: MALTEXTRACT Download resource files
195195
run: |
196-
mkdir -p databases/maltextract
197-
for i in ncbi.tre ncbi.map; do wget https://github.com/rhuebler/HOPS/raw/0.33/Resources/"$i" -P databases/maltextract/; done
196+
mkdir -p databases/maltextract
197+
for i in ncbi.tre ncbi.map; do wget https://github.com/rhuebler/HOPS/raw/0.33/Resources/"$i" -P databases/maltextract/; done
198198
- name: MALTEXTRACT Basic with MALT plus MaltExtract
199199
run: |
200-
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --run_bam_filtering --bam_unmapped_type 'fastq' --run_metagenomic_screening --metagenomic_tool 'malt' --database "/home/runner/work/eager/eager/databases/malt" --run_maltextract --maltextract_ncbifiles "/home/runner/work/eager/eager/databases/maltextract/" --maltextract_taxon_list 'https://raw.githubusercontent.com/nf-core/test-datasets/eager/testdata/Mammoth/maltextract/MaltExtract_list.txt'
200+
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --run_bam_filtering --bam_unmapped_type 'fastq' --run_metagenomic_screening --metagenomic_tool 'malt' --database "/home/runner/work/eager/eager/databases/malt" --run_maltextract --maltextract_ncbifiles "/home/runner/work/eager/eager/databases/maltextract/" --maltextract_taxon_list 'https://raw.githubusercontent.com/nf-core/test-datasets/eager/testdata/Mammoth/maltextract/MaltExtract_list.txt'
201201
- name: METAGENOMIC Run the basic pipeline but with unmapped reads going into Kraken
202202
run: |
203203
nextflow run ${GITHUB_WORKSPACE} -profile test_tsv_kraken,docker --run_bam_filtering --bam_unmapped_type 'fastq'
@@ -216,4 +216,4 @@ jobs:
216216
nextflow run ${GITHUB_WORKSPACE} -profile test_tsv_humanbam,docker --skip_fastqc --skip_adapterremoval --skip_deduplication --skip_qualimap --skip_preseq --skip_damage_calculation --run_mtnucratio
217217
- name: RESCALING Run basic pipeline with basic pipeline but with mapDamage rescaling of BAM files. Note this will be slow
218218
run: |
219-
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --run_mapdamage_rescaling --run_genotyping --genotyping_tool hc --genotyping_source 'rescaled'
219+
nextflow run ${GITHUB_WORKSPACE} -profile test,docker --run_mapdamage_rescaling --run_genotyping --genotyping_tool hc --genotyping_source 'rescaled'

.github/workflows/linting.yml

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ jobs:
4545
repo-token: ${{ secrets.GITHUB_TOKEN }}
4646
allow-repeats: false
4747

48-
4948
YAML:
5049
runs-on: ubuntu-latest
5150
steps:
@@ -82,11 +81,9 @@ jobs:
8281
repo-token: ${{ secrets.GITHUB_TOKEN }}
8382
allow-repeats: false
8483

85-
8684
nf-core:
8785
runs-on: ubuntu-latest
8886
steps:
89-
9087
- name: Check out pipeline code
9188
uses: actions/checkout@v2
9289

@@ -99,8 +96,8 @@ jobs:
9996
10097
- uses: actions/setup-python@v1
10198
with:
102-
python-version: '3.6'
103-
architecture: 'x64'
99+
python-version: "3.6"
100+
architecture: "x64"
104101

105102
- name: Install dependencies
106103
run: |
@@ -127,4 +124,3 @@ jobs:
127124
lint_log.txt
128125
lint_results.md
129126
PR_number.txt
130-

0 commit comments

Comments
 (0)