Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Absorbs latest nfcore and cgpu fork changes #6

Merged
merged 251 commits into from
Jan 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
251 commits
Select commit Hold shift + click to select a range
406f18c
Merge remote-tracking branch 'upstream/dev' into dev
apeltzer Sep 6, 2019
e223831
nf-core bump-version . 2.5.1dev
maxulysse Oct 8, 2019
5a1c386
Remove PublishDirMode from test profile (#40)
maxulysse Oct 9, 2019
436af40
update all tools
maxulysse Oct 9, 2019
0dd9461
minor updates + typo fix (#42)
maxulysse Oct 9, 2019
af40f23
Merge pull request #41 from MaxUlysse/environmentUpdate
maxulysse Oct 9, 2019
9c977de
fix VEP automated builds
maxulysse Oct 10, 2019
db7bac3
Merge pull request #43 from MaxUlysse/VEP
maxulysse Oct 10, 2019
f0e8225
add location for abstracts
maxulysse Oct 11, 2019
2eef743
remove reference to old buil.nf script
maxulysse Oct 11, 2019
5df80a5
update CHANGELOG
maxulysse Oct 11, 2019
318a7ab
Update docs/reference.md
maxulysse Oct 11, 2019
c8f748f
Update docs/reference.md
maxulysse Oct 11, 2019
4445847
Update docs/reference.md
maxulysse Oct 11, 2019
f1483ac
Worfklow (#45)
maxulysse Oct 11, 2019
907a75f
Merge branch 'dev' into docs
maxulysse Oct 11, 2019
f92710c
Merge pull request #46 from MaxUlysse/docs
maxulysse Oct 21, 2019
2b2f7e8
add minimal genome and update some processes
maxulysse Oct 21, 2019
89116c7
Merge remote-tracking branch 'upstream/dev' into dev
apeltzer Oct 21, 2019
065ae50
Start adding mouse data
apeltzer Oct 21, 2019
77ec187
Update iGenomes.config
apeltzer Oct 21, 2019
db69d29
Add tbi
apeltzer Oct 21, 2019
8995981
Drop ASCAT files
apeltzer Oct 21, 2019
d1a2e13
apply changes from 2.5.1 to dev
maxulysse Oct 22, 2019
a0179d4
bump version to 2.5.2dev
maxulysse Oct 22, 2019
7a6650e
update CHANGELOG
maxulysse Oct 22, 2019
416e7c8
Merge pull request #54 from MaxUlysse/fix
apeltzer Oct 23, 2019
a7cb0f1
update tiddit to 2.8.1
maxulysse Oct 28, 2019
f0dfba4
Merge pull request #55 from MaxUlysse/bioconda
maxulysse Oct 28, 2019
0d1e56c
Use Version 98 of Mouse
apeltzer Oct 28, 2019
9195f0f
Add for grcm38
apeltzer Oct 28, 2019
228592d
Adjust mus musculus DB
apeltzer Oct 28, 2019
e216b24
Annotation
apeltzer Oct 28, 2019
5c13e43
add smallerGRCh37 and minimalGRCh37
maxulysse Oct 28, 2019
05d174d
use bwa aln when no knowIndels, otherwise use bwa mem, noIntervals cu…
maxulysse Oct 28, 2019
c61768b
don't use bwa aln
maxulysse Oct 29, 2019
044de75
add automatic generation of intervals file based on fastaFai file
maxulysse Oct 29, 2019
0dacda1
Adjusted genomes.config
apeltzer Oct 30, 2019
9a35195
Should be list
apeltzer Oct 30, 2019
e6c07a5
Set genomes_base to something
apeltzer Oct 30, 2019
934622d
Revert back
apeltzer Oct 30, 2019
1cde457
enable CreateIntervalsBed for intervals_list from GATK Bundle
maxulysse Oct 30, 2019
985af84
Add proper calling list
apeltzer Oct 30, 2019
da5ea62
Use the bed file
apeltzer Oct 30, 2019
793ba99
remove temp file
maxulysse Oct 30, 2019
962ebe6
update CHANGELOG
maxulysse Oct 30, 2019
888a220
Fix genome fa.fai
apeltzer Oct 30, 2019
17e1f23
Add in mgpv5
apeltzer Oct 30, 2019
c3c6e93
Try short track
apeltzer Oct 31, 2019
7fa9756
Add in species handling
apeltzer Oct 31, 2019
2f9530f
Document new parameter species
apeltzer Oct 31, 2019
30e6b4c
Add changelog
apeltzer Oct 31, 2019
c86114a
Fix iGenomes stuff
apeltzer Oct 31, 2019
9ba7c6f
Add in note about GRCm38
apeltzer Oct 31, 2019
624bab1
Merge branch 'dev' into dev
maxulysse Oct 31, 2019
b33576b
Fix small fai index issue
apeltzer Oct 31, 2019
af66811
Merge branch 'dev' of https://github.com/apeltzer/sarek into dev
apeltzer Oct 31, 2019
c70dd71
Adjusted quotes in genomes.config
apeltzer Oct 31, 2019
fffc46f
And the same for igenomes
apeltzer Oct 31, 2019
2c821e4
Better folder structure for Mouse Genome Project data
apeltzer Oct 31, 2019
0925189
Minor adjustment to propoer paths
apeltzer Oct 31, 2019
12a5152
Apply suggestions from code review
apeltzer Oct 31, 2019
92be499
Remove space
apeltzer Oct 31, 2019
98ea898
Move it up
apeltzer Oct 31, 2019
bf3f262
Update CHANGELOG.md
apeltzer Oct 31, 2019
0f01d2e
Merge remote-tracking branch 'upstream/dev' into minimal
maxulysse Nov 4, 2019
ebe3b98
Merge pull request #52 from apeltzer/dev
maxulysse Nov 4, 2019
f710004
Merge remote-tracking branch 'upstream/dev' into minimal
maxulysse Nov 4, 2019
55593c0
Merge pull request #58 from MaxUlysse/Intervals
maxulysse Nov 4, 2019
1bebb78
add minimal tests
maxulysse Nov 4, 2019
528cc1f
fix processes with no intervals
maxulysse Nov 4, 2019
4b7d1ff
add comments
maxulysse Nov 4, 2019
80335a8
Merge remote-tracking branch 'upstream/dev' into minimal
maxulysse Nov 4, 2019
f1cdd93
params noIntervals -> no_intervals
maxulysse Nov 4, 2019
daca2ba
sort genomes + add news
maxulysse Nov 4, 2019
3fce99c
code polishing
maxulysse Nov 4, 2019
7adfe02
update CHANGELOG
maxulysse Nov 4, 2019
0401b89
add split_fastq params to split the fastq files with the splitFastq()…
maxulysse Nov 5, 2019
bab5604
add tests
maxulysse Nov 5, 2019
cbd8156
temporarely remove TIDDIT tests
maxulysse Nov 5, 2019
f3312d9
add sention for bwa mem
maxulysse Nov 5, 2019
9f08533
disable docker and singularity
maxulysse Nov 5, 2019
477a99f
disable container
maxulysse Nov 5, 2019
0cf67ca
add fastaFai for bwamem
maxulysse Nov 5, 2019
c55c19f
remove module samtools from label sentieon
maxulysse Nov 5, 2019
6a06f02
fix output from bwa mem
maxulysse Nov 5, 2019
aea3512
fix output channel BamMapped from MapReads
maxulysse Nov 5, 2019
b93b1f2
set params.sentieon to null by default
maxulysse Nov 5, 2019
313fda0
add SentieonDedup process
maxulysse Nov 5, 2019
152016e
fix typo
maxulysse Nov 5, 2019
962600e
add fastaFai to SentieonDedup process
maxulysse Nov 5, 2019
22f545c
fix bam indexing
maxulysse Nov 5, 2019
ea839de
fix bam indexing
maxulysse Nov 5, 2019
3419fd9
fix bam indexing
maxulysse Nov 5, 2019
4f6154e
add SentieonBQSR
maxulysse Nov 5, 2019
7e00bb2
add label sentieon to SentieonBQSR
maxulysse Nov 5, 2019
04395c7
fix metrics output for SentieonBQSR
maxulysse Nov 5, 2019
c31bf4e
increase cpus for Sentieon BQSR
maxulysse Nov 8, 2019
2d5f759
remove indexing
maxulysse Nov 8, 2019
23a88b3
add index for dedup
maxulysse Nov 11, 2019
bc55997
bwa mem sentieon specific process
maxulysse Nov 12, 2019
d874bd6
TSV file for sentieon Dedup
maxulysse Nov 12, 2019
2ce9735
TSV for every step for Sentieon
maxulysse Nov 12, 2019
babb391
recal -> deduped
maxulysse Nov 12, 2019
bea7238
fix input for TSV recalibrate
maxulysse Nov 12, 2019
efaec9f
enable restart from recalibrate with TSV with Sentieon
maxulysse Nov 12, 2019
f5744e4
fix sention variant calling from mapping and recalibrate
maxulysse Nov 12, 2019
ee5beaf
code polishing
maxulysse Nov 12, 2019
88f4af3
add dump tag for imput sample
maxulysse Nov 12, 2019
2b6842f
add dump tag for bamDedupedSentieon
maxulysse Nov 12, 2019
1b979e5
code polishing
maxulysse Nov 12, 2019
60a9fb3
code polishing
maxulysse Nov 12, 2019
dc25d27
code polishing
maxulysse Nov 12, 2019
fba89d0
code polishing
maxulysse Nov 12, 2019
6f73d83
remove when statement
maxulysse Nov 12, 2019
b0f091e
fix typo
maxulysse Nov 12, 2019
1aa82a9
remove tsv for recalibrate with sentieon
maxulysse Nov 12, 2019
bbe01fb
add dnascope dnaseq
maxulysse Nov 12, 2019
2d980d8
fix dnascope
maxulysse Nov 12, 2019
f67f8f3
add TNscope process
maxulysse Nov 13, 2019
9d6c76e
fix TNscope output
maxulysse Nov 13, 2019
0aa8ebe
add pon for TNscope
maxulysse Nov 13, 2019
10ad687
add params.pon_index
maxulysse Nov 13, 2019
03332fc
add annotation for sention DNAseq, DNAscope, TNscope
maxulysse Nov 13, 2019
afc5046
add default pon_index
maxulysse Nov 13, 2019
dd7c1f8
typo
maxulysse Nov 13, 2019
0c29e69
fix typo
maxulysse Nov 13, 2019
2fe67d5
improve automatic annotation
maxulysse Nov 13, 2019
2bbc127
typo
maxulysse Nov 13, 2019
66276c3
typo
maxulysse Nov 13, 2019
fc27dd0
add condition on when statement on TNscope
maxulysse Nov 13, 2019
6d91247
clean up
maxulysse Nov 14, 2019
c23306b
code polish
maxulysse Nov 14, 2019
07e8502
add CODEOWNERS file
maxulysse Nov 15, 2019
a85b9be
add when statement on all sentieon processes with params.sentieon
maxulysse Nov 18, 2019
90bfe28
Merge pull request #69 from MaxUlysse/CODEOWNERS
maxulysse Nov 19, 2019
b84cbc4
remove munin sentieon specific configs from config
maxulysse Nov 20, 2019
38d113e
load sarek specific config
maxulysse Nov 20, 2019
daaf48f
update path to specific config
maxulysse Nov 20, 2019
485ac14
update docs
maxulysse Nov 28, 2019
e7d4428
remove Freebayes
maxulysse Nov 28, 2019
a48c35e
update workflow image
maxulysse Nov 28, 2019
c599311
remove old logo
maxulysse Nov 28, 2019
5ee1bcd
Merge remote-tracking branch 'upstream/dev' into splitFastq
maxulysse Nov 28, 2019
b6942fd
fix tests
maxulysse Nov 29, 2019
503c102
add docs about params split_fastq
maxulysse Nov 29, 2019
7176fa5
update CHANGELOG
maxulysse Nov 29, 2019
d0ff576
improve docs
maxulysse Dec 2, 2019
8c0cf0d
more tests but less NF versions
maxulysse Dec 2, 2019
df3d68a
actually run the tests
maxulysse Dec 2, 2019
9b3a027
typo
maxulysse Dec 2, 2019
b3aca7e
Merge pull request #61 from MaxUlysse/splitFastq
maxulysse Dec 2, 2019
8bdd58c
Merge branch 'dev' into minimal
maxulysse Dec 2, 2019
6b76428
simplify configs
maxulysse Dec 2, 2019
b696b5a
add test for mpileup
maxulysse Dec 2, 2019
c9f75d0
Merge remote-tracking branch 'upstream/dev' into DOCS
maxulysse Dec 2, 2019
67c5309
go crazy with tests
maxulysse Dec 3, 2019
a44ae39
fix tests
maxulysse Dec 3, 2019
b0a6557
includ test.config
maxulysse Dec 3, 2019
9ab028d
restore FreeBayes
maxulysse Dec 3, 2019
67e5001
remove label memory_max from BaseRecalibrator process to fix #72
maxulysse Dec 3, 2019
fc08c2e
Merge pull request #73 from MaxUlysse/MemoryBaseRecalibrator
maxulysse Dec 4, 2019
4db8a77
Merge branch 'dev' into DOCS
maxulysse Dec 4, 2019
f07f043
Merge pull request #71 from MaxUlysse/DOCS
maxulysse Dec 4, 2019
6f1d39f
Merge remote-tracking branch 'upstream/dev' into minimal
maxulysse Dec 6, 2019
89cbf62
add --skipQC all and --tools Manta,mpileup,Strelka to minimal genome …
maxulysse Dec 6, 2019
3e045b0
update Nextflow version
maxulysse Dec 6, 2019
544a9d5
update Nextflow version
maxulysse Dec 6, 2019
e2f01e9
update Nextflow
maxulysse Dec 6, 2019
361716a
add --step annotation to profile
maxulysse Dec 6, 2019
357138b
don't need to specify step here
maxulysse Dec 6, 2019
83fcf65
move params initalization
maxulysse Dec 6, 2019
67dd637
add docs
maxulysse Dec 6, 2019
430a09b
fix markdownlint
maxulysse Dec 6, 2019
22d386a
more complete docs + sort genomes
maxulysse Dec 6, 2019
e2b3101
Merge pull request #60 from MaxUlysse/minimal
maxulysse Dec 6, 2019
63f48c6
improve tests
maxulysse Dec 9, 2019
21e2b3a
update docs
maxulysse Dec 9, 2019
bdec005
update CHANGELOG
maxulysse Dec 9, 2019
20c2a44
improve script
maxulysse Dec 9, 2019
d90d0b7
fix tests
maxulysse Dec 9, 2019
5355c1e
better comments
maxulysse Dec 9, 2019
0612068
Merge pull request #74 from MaxUlysse/CLEANUP
maxulysse Dec 9, 2019
4ce48d5
Merge remote-tracking branch 'upstream/dev' into sentieon
maxulysse Dec 9, 2019
dc043d0
better comments
maxulysse Dec 9, 2019
68571f4
fix error on channel name
maxulysse Dec 9, 2019
4286ef3
fix output for MergeBamRecal
maxulysse Dec 9, 2019
77de228
fix MergeBamRecal output
maxulysse Dec 10, 2019
72fb602
fix TSV file
maxulysse Dec 10, 2019
d896596
update comments and docs
maxulysse Dec 10, 2019
c75a95b
add warning for sentieon only processes
maxulysse Dec 10, 2019
af57a10
Merge pull request #66 from MaxUlysse/sentieon
maxulysse Dec 10, 2019
09deda6
nf-core bump-version . 2.5.2
maxulysse Dec 11, 2019
ce8c4df
manual bump-version . 2.5.2
maxulysse Dec 11, 2019
9b2df57
update workflow image
maxulysse Dec 11, 2019
bd44d7b
downgrade tools for release
maxulysse Dec 11, 2019
feb8656
update CHANGELOG
maxulysse Dec 11, 2019
8cd87a4
clean up and update workflow image
maxulysse Dec 12, 2019
dee21f5
allow a
maxulysse Dec 12, 2019
f561227
fix workflow image
maxulysse Dec 12, 2019
6998e17
Merge pull request #77 from MaxUlysse/2.5.2
maxulysse Dec 12, 2019
e0f843d
Apply suggestions from code review
maxulysse Dec 12, 2019
c73d94d
Apply suggestions from code review
maxulysse Dec 12, 2019
eeb5fec
Update docs/output.md
maxulysse Dec 12, 2019
148ae3c
Apply suggestions from code review
maxulysse Dec 13, 2019
6fa8693
Apply suggestions from code review
maxulysse Dec 13, 2019
4faec93
Apply suggestions from code review
maxulysse Dec 13, 2019
eb22a0c
Merge branch 'master' into dev
maxulysse Dec 16, 2019
5c30fd8
Merge branch 'dev'
maxulysse Dec 16, 2019
c3a9567
Reformats `bwa mem | samtools sort` command; WIP suboptimal resource …
cgpu Dec 20, 2019
126603a
Addresses https://github.com/PGP-UK/GenomeChronicler-Sarek-nf/issues/…
cgpu Dec 23, 2019
70ad1e3
Restores mapping to nf-core; Keeps gatk *Spark
cgpu Dec 23, 2019
e8c29b1
Merge pull request #8 from cgpu/nf-core-master
cgpu Dec 23, 2019
7baf2fe
Removes max_ resource alloc labels from MarkDuplicatesSpark
cgpu Dec 23, 2019
f8e4a24
Replaces .md.bam.bai->.md.bai (same as nf-core)
cgpu Dec 23, 2019
9e07cc6
Add ${markdup_java_options} to MarkDuplicatesSpark (same as nf-core M…
cgpu Dec 23, 2019
675f7fd
Changes MarkDuplicates --verbosity, DEBUG->INFO
cgpu Dec 23, 2019
575543a
Changes intervalBed.simpleName->intervalBed.baseName; nf-cored
cgpu Dec 23, 2019
df5d112
Removes label cpus_1 from BaseRecalibratorSpark
cgpu Dec 23, 2019
3106413
Remove cpus_2 labels from ApplyBQSRSpark; DEBUG->INFO
cgpu Dec 23, 2019
b4c5419
Changes pseudo file "no_vepFile.txt" from https to s3 link
cgpu Dec 23, 2019
dab01e1
Removes java options from ApplyBQSRSpark
cgpu Dec 23, 2019
ae2800f
Removes java options from MarkDupesSpark
cgpu Dec 23, 2019
d83907e
Add java-options to MarkDupesSpark; verbosity INFO->ERROR
cgpu Dec 24, 2019
8780b48
Fixes dupe --java-options; :facepalm:
cgpu Dec 24, 2019
db90372
Attempt to fix MarkDupesSpark; "--lower-case"->"-CAP"; Removed tmp
cgpu Dec 24, 2019
17b84bb
Adds soft-coded allocation of resources to MapReads
cgpu Dec 24, 2019
7f7e0c8
Initialise params for MapReads split resource alloc
cgpu Dec 24, 2019
53f68a1
Adds neglected curlies around params
cgpu Dec 24, 2019
894a21c
Adds neglected \ to bash vars
cgpu Dec 24, 2019
7f71929
Adds neglected \ to bash vars
cgpu Dec 24, 2019
b59c278
WIP; MapReads optimisations
cgpu Dec 27, 2019
c3c0b43
Implement resource alloc between bwa and samtools
cgpu Jan 2, 2020
30c031d
Adds max, med soft coded resource alloc
cgpu Jan 2, 2020
d9fc37b
Re-labels processes (from hard coded resources to soft)
cgpu Jan 2, 2020
563b6d8
Adds extra curlies to addrees priority of eval
cgpu Jan 2, 2020
e922b89
Add explicit declaration of maxForks/process
cgpu Jan 2, 2020
7c299bd
Update med resource allocation function
cgpu Jan 2, 2020
208f61c
Add echo true and echo of ${bwa_cpus} and ${sort_cpus}
cgpu Jan 2, 2020
ece5cc8
Hard code heap in MarkDuplicatesSpark at 8g
cgpu Jan 2, 2020
78764c8
Correct expected output bai in MarkDupes
cgpu Jan 2, 2020
48e6924
Removes Spark versions; Not stable with low resources
cgpu Jan 8, 2020
93f6f3e
Removes sorting; Picard might sort?
cgpu Jan 8, 2020
54c92cf
Do not assume sorting in MarkDupes
cgpu Jan 8, 2020
ce74cf5
Adds explicit --ASSUME_SORT_ORDER unsorted
cgpu Jan 9, 2020
0b6321e
Adds missing \\
cgpu Jan 9, 2020
fe9bd23
Omits -k 23
cgpu Jan 9, 2020
bd86d0c
Bringing sorted back
cgpu Jan 9, 2020
bd2c4bb
Eliminating pipes in mapping step
cgpu Jan 9, 2020
d1e60c2
Adds bwa -k 23 and GenomeChronicler as tool (#16)
cgpu Jan 10, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ jobs:
- checkout
- setup_remote_docker
- run:
command: docker build -t nfcore/sareksnpeff:2.5.1.${GENOME} containers/snpeff/. --build-arg GENOME=${GENOME} --build-arg SNPEFF_CACHE_VERSION=${SNPEFF_CACHE_VERSION}
command: docker build -t nfcore/sareksnpeff:2.5.2.${GENOME} containers/snpeff/. --build-arg GENOME=${GENOME} --build-arg SNPEFF_CACHE_VERSION=${SNPEFF_CACHE_VERSION}
- run:
command: |
echo "$DOCKERHUB_PASS" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin
docker push nfcore/sareksnpeff:2.5.1.${GENOME}
docker push nfcore/sareksnpeff:2.5.2.${GENOME}

snpeffgrch38:
<< : *buildsnpeff
Expand Down Expand Up @@ -45,10 +45,10 @@ jobs:
- checkout
- setup_remote_docker
- run:
command: docker build -t nfcore/sarekvep:2.5.1.${GENOME} containers/vep/. --build-arg GENOME=${GENOME} --build-arg SPECIES=${SPECIES} --build-arg VEP_VERSION=${VEP_VERSION}
command: docker build -t nfcore/sarekvep:2.5.2.${GENOME} containers/vep/. --build-arg GENOME=${GENOME} --build-arg SPECIES=${SPECIES} --build-arg VEP_VERSION=${VEP_VERSION}
no_output_timeout: 3h
- run:
command: echo "$DOCKERHUB_PASS" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin ; docker push nfcore/sarekvep:2.5.1.${GENOME}
command: echo "$DOCKERHUB_PASS" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin ; docker push nfcore/sarekvep:2.5.2.${GENOME}

vepgrch38:
<< : *buildvep
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @MaxUlysse
52 changes: 31 additions & 21 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,57 @@
# nf-core/sarek: Contributing Guidelines

Hi there! Many thanks for taking an interest in improving nf-core/sarek.
Hi there!
Many thanks for taking an interest in improving nf-core/sarek.

We try to manage the required tasks for nf-core/sarek using GitHub issues, you probably came to this page when creating one. Please use the pre-filled template to save time.

However, don't be put off by this template - other more general issues and suggestions are welcome! Contributions to the code are even more welcome ;)

> If you need help using or modifying nf-core/sarek then the best place to ask is on the pipeline channel on [Slack](https://nf-core-invite.herokuapp.com/).
We try to manage the required tasks for nf-core/sarek using GitHub issues, you probably came to this page when creating one.
Please use the pre-filled template to save time.

However, don't be put off by this template - other more general issues and suggestions are welcome!
Contributions to the code are even more welcome ;)

> If you need help using or modifying nf-core/sarek then the best place to ask is on the nf-core Slack [#sarek](https://nfcore.slack.com/channels/sarek) channel ([join our Slack here](https://nf-co.re/join/slack)).

## Contribution workflow
If you'd like to write some code for nf-core/sarek, the standard workflow
is as follows:

1. Check that there isn't already an issue about your idea in the
[nf-core/sarek issues](https://github.com/nf-core/sarek/issues) to avoid
duplicating work.
If you'd like to write some code for nf-core/sarek, the standard workflow is as follows:

1. Check that there isn't already an issue about your idea in the [nf-core/sarek issues](https://github.com/nf-core/sarek/issues) to avoid duplicating work
* If there isn't one already, please create one so that others know you're working on this
2. Fork the [nf-core/sarek repository](https://github.com/nf-core/sarek) to your GitHub account
2. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/sarek repository](https://github.com/nf-core/sarek) to your GitHub account
3. Make the necessary changes / additions within your forked repository
4. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged.

If you're not used to this workflow with git, you can start with some [basic docs from GitHub](https://help.github.com/articles/fork-a-repo/) or even their [excellent interactive tutorial](https://try.github.io/).
4. Submit a Pull Request against the `dev` branch and wait for the code to be reviewed and merged

If you're not used to this workflow with git, you can start with some [docs from GitHub](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests) or even their [excellent `git` resources](https://try.github.io/).

## Tests
When you create a pull request with changes, [Travis CI](https://travis-ci.org/) will run automatic tests.

When you create a pull request with changes, [GitHub Actions](https://github.com/features/actions) will run automatic tests.
Typically, pull-requests are only fully reviewed when these tests are passing, though of course we can help out before then.

There are typically two types of tests that run:

### Lint Tests
The nf-core has a [set of guidelines](http://nf-co.re/guidelines) which all pipelines must adhere to.

`nf-core` has a [set of guidelines](https://nf-co.re/developers/guidelines) which all pipelines must adhere to.
To enforce these and ensure that all pipelines stay in sync, we have developed a helper tool which runs checks on the pipeline code. This is in the [nf-core/tools repository](https://github.com/nf-core/tools) and once installed can be run locally with the `nf-core lint <pipeline-directory>` command.

If any failures or warnings are encountered, please follow the listed URL for more documentation.

### Pipeline Tests
Each nf-core pipeline should be set up with a minimal set of test-data.
Travis CI then runs the pipeline on this data to ensure that it exists successfully.

Each `nf-core` pipeline should be set up with a minimal set of test-data.
`GitHub Actions` then runs the pipeline on this data to ensure that it exits successfully.
If there are any failures then the automated tests fail.
These tests are run both with the latest available version of Nextflow and also the minimum required version that is stated in the pipeline code.
These tests are run both with the latest available version of `Nextflow` and also the minimum required version that is stated in the pipeline code.

## Patch

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

* On your own fork, make a new branch `patch` based on `upstream/master`.
* Fix the bug, and bump version (X.Y.Z+1).
* A PR should be made on `master` from patch to directly this particular bug.

## Getting help
For further information/help, please consult the [nf-core/sarek documentation](https://github.com/nf-core/sarek#documentation) and don't hesitate to get in touch on the [sarek pipeline channel](https://nfcore.slack.com/channels/sarek) on [Slack](https://nf-co.re/join/slack).

For further information/help, please consult the [nf-core/sarek documentation](https://nf-co.re/sarek/docs) and don't hesitate to get in touch on the nf-core Slack [#sarek](https://nfcore.slack.com/channels/sarek) channel ([join our Slack here](https://nf-co.re/join/slack)).
43 changes: 27 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,42 @@
# nf-core/sarek bug report

Hi there!

Thanks for telling us about a problem with the pipeline. Please delete this text and anything that's not relevant from the template below:
Thanks for telling us about a problem with the pipeline.
Please delete this text and anything that's not relevant from the template below:

## Describe the bug

#### Describe the bug
A clear and concise description of what the bug is.

#### Steps to reproduce
## Steps to reproduce

Steps to reproduce the behaviour:

1. Command line: `nextflow run ...`
2. See error: _Please provide your error message_

#### Expected behaviour
## Expected behaviour

A clear and concise description of what you expected to happen.

#### System:
- Hardware: [e.g. HPC, Desktop, Cloud...]
- Executor: [e.g. slurm, local, awsbatch...]
- OS: [e.g. CentOS Linux, macOS, Linux Mint...]
- Version [e.g. 7, 10.13.6, 18.3...]
## System

- Hardware: <!-- [e.g. HPC, Desktop, Cloud...] -->
- Executor: <!-- [e.g. slurm, local, awsbatch...] -->
- OS: <!-- [e.g. CentOS Linux, macOS, Linux Mint...] -->
- Version <!-- [e.g. 7, 10.13.6, 18.3...] -->

## Nextflow Installation

- Version: <!-- [e.g. 19.10.0] -->

## Container engine

#### Nextflow Installation:
- Version: [e.g. 0.31.0]
- Engine: <!-- [e.g. Conda, Docker or Singularity] -->
- version: <!-- [e.g. 1.0.0] -->
- Image tag: <!-- [e.g. nfcore/sarek:2.5.1] -->

#### Container engine:
- Engine: [e.g. Conda, Docker or Singularity]
- version: [e.g. 1.0.0]
- Image tag: [e.g. nfcore/sarek:1.0.0]
## Additional context

#### Additional context
Add any other context about the problem here.
18 changes: 13 additions & 5 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
# nf-core/sarek feature request

Hi there!

Thanks for suggesting a new feature for the pipeline! Please delete this text and anything that's not relevant from the template below:
Thanks for suggesting a new feature for the pipeline!
Please delete this text and anything that's not relevant from the template below:

## Is your feature request related to a problem? Please describe

#### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.

Ex. I'm always frustrated when [...]

#### Describe the solution you'd like
## Describe the solution you'd like

A clear and concise description of what you want to happen.

#### Describe alternatives you've considered
## Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

#### Additional context
## Additional context

Add any other context about the feature request here.
23 changes: 13 additions & 10 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
Many thanks to contributing to nf-core/sarek!
# nf-core/sarek pull request

Many thanks for contributing to nf-core/sarek!

Please fill in the appropriate checklist below (delete whatever is not relevant).
These are the most common things requested on pull requests (PRs).

## PR checklist
- [ ] This comment contains a description of changes (with reason)
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If necessary, also make a PR on the [nf-core/sarek branch on the nf-core/test-datasets repo](https://github.com/nf-core/test-datasets/pull/new/nf-core/sarek)
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
- [ ] Make sure your code lints (`nf-core lint .`).
- [ ] Documentation in `docs` is updated
- [ ] `CHANGELOG.md` is updated
- [ ] `README.md` is updated

**Learn more about contributing:** [guidelines](https://github.com/nf-core/sarek/tree/master/.github/CONTRIBUTING.md)
- [ ] This comment contains a description of changes (with reason)
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If necessary, also make a PR on the [nf-core/sarek branch on the nf-core/test-datasets repo](https://github.com/nf-core/test-datasets/pull/new/nf-core/sarek)
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker`).
- [ ] Make sure your code lints (`nf-core lint .`).
- [ ] Documentation in `docs` is updated
- [ ] `CHANGELOG.md` is updated
- [ ] `README.md` is updated

**Learn more about contributing:** [CONTRIBUTING.md](https://github.com/nf-core/sarek/tree/master/.github/CONTRIBUTING.md)
4 changes: 3 additions & 1 deletion .github/markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ no-duplicate-header:
siblings_only: true
no-inline-html:
allowed_elements:
- img
- a
- img
- p
4 changes: 2 additions & 2 deletions .github/workflows/branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ on:

jobs:
test:
runs-on: ubuntu-latest
runs-on: ubuntu-18.04
steps:
# PRs are only ok if coming from an nf-core dev branch
- uses: actions/checkout@v1
- name: Check PRs
run: |
{ [[ $(git remote get-url origin) == *nf-core/sarek ]] && [[ ${GITHUB_BASE_REF} = "master" ]] && [[ ${GITHUB_HEAD_REF} = "dev" ]]; } || [[ ${GITHUB_HEAD_REF} == patch* ]]
{ [[ $(git remote get-url origin) == *nf-core/sarek ]] && [[ ${GITHUB_HEAD_REF} = "dev" ]]; } || [[ ${GITHUB_HEAD_REF} == "patch" ]]
24 changes: 0 additions & 24 deletions .github/workflows/ci-extra.yml

This file was deleted.

Loading