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

Dev -> master for v1.0.0 #47

Merged
merged 254 commits into from
Apr 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
254 commits
Select commit Hold shift + click to select a range
9ecdcc6
Update multiqc, add modules
pinin4fjords Dec 15, 2023
e874fe5
init testing
pinin4fjords Dec 15, 2023
d2c80bc
Update changelog
pinin4fjords Dec 15, 2023
64e3b3f
Add test data config for nf-core modules
pinin4fjords Dec 15, 2023
c7c30d9
fix workflow name in CI
pinin4fjords Dec 15, 2023
de3883b
Merge pull request #4 from nf-core/readd_functionality
pinin4fjords Dec 15, 2023
83bc601
update remaining modules
maxulysse Dec 15, 2023
07d17ca
fix linting
maxulysse Dec 15, 2023
d771894
update CHANGELOG
maxulysse Dec 15, 2023
dfe83a9
update snap for custom/dumpsoftwareversions
maxulysse Dec 15, 2023
d93bbd5
add nf-test to .gitignore
maxulysse Dec 15, 2023
80746f2
update snap for custom/dumpsoftwareversions
maxulysse Dec 15, 2023
e748206
exclude tests for custom/dumpsoftwareversions
maxulysse Dec 15, 2023
776ab58
Merge pull request #5 from maxulysse/fix_lint
maxulysse Dec 15, 2023
fc6fed4
Template update for nf-core/tools version 2.11
nf-core-bot Dec 19, 2023
667e27a
Template update for nf-core/tools version 2.11.1
nf-core-bot Dec 20, 2023
a3db3ec
Start adding preprocessing components from rnaseq
pinin4fjords Dec 20, 2023
d3be5ed
[skip ci] Unrestrict test resources while I'm mucking about
pinin4fjords Dec 21, 2023
6d96c75
Add gtf to schema
pinin4fjords Dec 21, 2023
c99d042
Reduce kmer size
pinin4fjords Dec 21, 2023
7131650
Trim before attempting strand detection
pinin4fjords Dec 21, 2023
a0f25d6
Add pass_trimmed_reads
pinin4fjords Dec 21, 2023
6c0f58e
Fix lib calls
pinin4fjords Dec 21, 2023
c8309d5
Fix test profile
pinin4fjords Dec 21, 2023
0e243ee
Update conf
pinin4fjords Dec 21, 2023
601aed2
Messy but working rnaseq-style proprocessing
pinin4fjords Dec 22, 2023
216ad1a
Encapsulated preprocessing
pinin4fjords Dec 22, 2023
2647cbc
Borrow more config from rnaseq
pinin4fjords Dec 22, 2023
22922dd
Reset test resources back
pinin4fjords Dec 22, 2023
89b57e4
Merge branch 'dev' into nf-core-template-merge-2.11.1
pinin4fjords Dec 22, 2023
bd3d90f
Merge pull request #7 from nf-core/nf-core-template-merge-2.11.1
pinin4fjords Jan 3, 2024
8c7b0dc
Merge branch 'dev' into preprocessing_from_rnaseq
pinin4fjords Jan 3, 2024
5933b28
Add test_data_base default
pinin4fjords Jan 3, 2024
58ce68c
Fix multiqc config
pinin4fjords Jan 3, 2024
9db1555
Bump to fix subworkflow tests
pinin4fjords Jan 11, 2024
81de6ed
Bump sortmerna
pinin4fjords Jan 11, 2024
81a01a7
Fix HISAT2 tests
pinin4fjords Jan 11, 2024
a4cc7ed
Bump cat/fastq and update config to fix
pinin4fjords Jan 23, 2024
5e33157
Override workflow config for testing fq/subsample
pinin4fjords Jan 23, 2024
b560b6e
Bump fq/subsample
pinin4fjords Jan 23, 2024
0b963ec
Set GFFREAD test args
pinin4fjords Jan 23, 2024
aae53f5
Bump gffread
pinin4fjords Jan 23, 2024
d9c4795
Totally suppress workflow ext.args for GFFREAD
pinin4fjords Jan 23, 2024
08526e6
Run prettier
pinin4fjords Jan 23, 2024
086846e
Arrange subworkflow better
pinin4fjords Jan 23, 2024
8cffca8
Fix relative includes for new subworkflow location
pinin4fjords Jan 23, 2024
bc548a6
Bump outdated modules
pinin4fjords Jan 23, 2024
4b88f15
Update modules/local/gtf2bed/main.nf
pinin4fjords Jan 26, 2024
aeffe21
Apply rnaseq -> riboseq fixes from code review
pinin4fjords Jan 26, 2024
60b4e46
Template update for nf-core/tools version 2.12
nf-core-bot Jan 29, 2024
4a0099f
Merge pull request #8 from nf-core/preprocessing_from_rnaseq
pinin4fjords Jan 29, 2024
66fb923
Take rnaseq preprocessing workflow from nf-core
pinin4fjords Feb 1, 2024
d11867d
Fix non-unique test errors
pinin4fjords Feb 1, 2024
67ce81a
Bump fastp for test ids
pinin4fjords Feb 1, 2024
f465794
update changelog
pinin4fjords Feb 1, 2024
d342d34
Bump multiqc
pinin4fjords Feb 1, 2024
81a3236
Merge branch 'dev' into nf-core-template-merge-2.12
pinin4fjords Feb 1, 2024
f489ab5
Add multqc snap
pinin4fjords Feb 1, 2024
60dc0b8
fix test_data_base default
pinin4fjords Feb 1, 2024
858c289
Update CHANGELOG.md
pinin4fjords Feb 1, 2024
aacf8a2
Merge pull request #10 from nf-core/preprocessing_from_nfcore
pinin4fjords Feb 2, 2024
4b4d1fa
Merge branch 'dev' into nf-core-template-merge-2.12
pinin4fjords Feb 2, 2024
2610f83
make .gitignore match template
pinin4fjords Feb 2, 2024
064dee1
Fix prettier ignore
pinin4fjords Feb 2, 2024
b906265
Fix linting of resolved variable
pinin4fjords Feb 2, 2024
1ae2c55
Fix some linting issues
pinin4fjords Feb 2, 2024
2f64b92
Linting fixes
pinin4fjords Feb 2, 2024
6a5b0a0
Prettier fixes
pinin4fjords Feb 2, 2024
a12e9f7
Update CHANGELOG
pinin4fjords Feb 2, 2024
f3081eb
Update CHANGELOG.md
pinin4fjords Feb 2, 2024
ca556ad
Merge pull request #9 from nf-core/nf-core-template-merge-2.12
pinin4fjords Feb 2, 2024
e0df23d
Install star alignment
pinin4fjords Feb 2, 2024
be35e83
Try alignment
pinin4fjords Feb 6, 2024
c2e35fb
Enable alignment/ post-alignment parts
pinin4fjords Feb 7, 2024
3a30d78
Bump resources
pinin4fjords Feb 7, 2024
6dd9643
Swtich test chromosome to reduce resources
pinin4fjords Feb 9, 2024
0f843e7
Switch to align_fastq_star subworkflow
pinin4fjords Feb 16, 2024
480a96e
Remove resource limits for full tests
pinin4fjords Feb 16, 2024
381c77e
Add UMI handling from nf-core/rnaseq
pinin4fjords Feb 16, 2024
08eb74c
Update/ add missing components
pinin4fjords Feb 19, 2024
d101540
Fix linting
pinin4fjords Feb 19, 2024
b6267b0
Update changelog
pinin4fjords Feb 19, 2024
bb5592b
Tweak STAR setup for ribotish
pinin4fjords Feb 19, 2024
4531bfa
Remove development artifacts
pinin4fjords Feb 19, 2024
e8e5729
Update conf/test_full.config
pinin4fjords Feb 19, 2024
d719843
Appease @maxulysse 's order fetish :-)
pinin4fjords Feb 19, 2024
74fc9f3
Merge branch 'alignment_phase' of github.com:nf-core/riboseq into ali…
pinin4fjords Feb 19, 2024
d14a8d9
Merge pull request #12 from nf-core/alignment_phase
pinin4fjords Feb 19, 2024
dffd2a8
Template update for nf-core/tools version 2.13
nf-core-bot Feb 20, 2024
47b84f8
Resolve template merge and update structure
pinin4fjords Feb 22, 2024
858076e
Update CHANGELOG
pinin4fjords Feb 22, 2024
2b6f02a
Reenable pipeline completion
pinin4fjords Feb 22, 2024
942f861
Appease eclint
pinin4fjords Feb 22, 2024
904e578
Prettier
pinin4fjords Feb 22, 2024
0d4dff0
Remove dumpsoftwareversions mentions
pinin4fjords Feb 22, 2024
092db6d
Fix modules.json
pinin4fjords Feb 22, 2024
2c0b603
See what fetchngs CI config does
pinin4fjords Feb 22, 2024
972eeff
Add find_changed_files.py
pinin4fjords Feb 22, 2024
c4a7509
Set pipeline test params
pinin4fjords Feb 22, 2024
9a91d22
Merge pull request #32 from nf-core/nf-core-template-merge-2.13_jon
pinin4fjords Feb 22, 2024
63e8c17
Reorder preprocessing step and make sure ribo rna removal is optional
pinin4fjords Feb 24, 2024
ceb06db
Update CHANGELOG
pinin4fjords Feb 24, 2024
ed5adff
Merge pull request #34 from nf-core/fix_preprocessing
pinin4fjords Feb 26, 2024
de77182
Bump preprocess_rnaseq for sortmerna efficency
pinin4fjords Feb 26, 2024
0adfc5c
Add sortmerna to preparetoolindices
pinin4fjords Feb 26, 2024
92943d8
Fix config
pinin4fjords Feb 26, 2024
cb60c4b
syntax fix
pinin4fjords Feb 26, 2024
d436a0a
Small fixes
pinin4fjords Feb 26, 2024
aadc1e9
think we need a value channel
pinin4fjords Feb 26, 2024
32a61d7
think we need a value channel
pinin4fjords Feb 26, 2024
4164a89
think we need a value channel
pinin4fjords Feb 26, 2024
7bb7917
Bump subworkflow
pinin4fjords Feb 26, 2024
b494ba9
Fix sortmerna indexing
pinin4fjords Feb 26, 2024
6fc0d19
Appease linting
pinin4fjords Feb 27, 2024
509b7ff
Add missing test configs
pinin4fjords Feb 27, 2024
ae43543
Update CHANGELOG
pinin4fjords Feb 27, 2024
079676b
Bump subworkflow after PR
pinin4fjords Feb 27, 2024
2777636
Merge pull request #35 from nf-core/sortmerna_index_once
pinin4fjords Feb 27, 2024
9af6854
Set overwrite flag in bbsplit
pinin4fjords Feb 27, 2024
e2db003
Install bbsplit module with hack
pinin4fjords Feb 28, 2024
e8c6f6d
Fix module install location
pinin4fjords Feb 29, 2024
55d3775
Update changelog
pinin4fjords Feb 29, 2024
bc8ceb3
Merge pull request #36 from nf-core/bbmap_no_overwrite
pinin4fjords Feb 29, 2024
d1b7162
Template update for nf-core/tools version 2.13.1
nf-core-bot Feb 29, 2024
4ca2b84
Update test links
pinin4fjords Mar 6, 2024
c60d87a
Merge branch 'dev' into nf-core-template-merge-2.13.1
pinin4fjords Mar 6, 2024
4728741
Fix tests
pinin4fjords Mar 6, 2024
2d1c86c
update changelog
pinin4fjords Mar 6, 2024
ac6fc64
reduce ribo db manifest for testing
pinin4fjords Mar 6, 2024
dbb8550
Merge pull request #38 from nf-core/nf-core-template-merge-2.13.1
pinin4fjords Mar 6, 2024
e5ab091
working and configured
pinin4fjords Mar 11, 2024
2bb4c2d
Adapt an output.md from nf-core/rnaseq
pinin4fjords Mar 12, 2024
ffc8276
Add missing docs images
pinin4fjords Mar 12, 2024
2326913
Update usage
pinin4fjords Mar 12, 2024
a695427
Fix linting
pinin4fjords Mar 12, 2024
8035565
Remove hisat2, not currently used
pinin4fjords Mar 12, 2024
86a6aa6
Update modules.json
pinin4fjords Mar 12, 2024
43f5160
Add new config template
pinin4fjords Mar 12, 2024
82bebf0
Commit ribotish modules install
pinin4fjords Mar 12, 2024
9c76968
linting fixes
pinin4fjords Mar 12, 2024
6bd65a1
Update modules
pinin4fjords Mar 12, 2024
f53a56b
linting fixes
pinin4fjords Mar 12, 2024
2653189
Update image from template
pinin4fjords Mar 12, 2024
97794cc
Reinstate hisat2 modules to prevent need to rework prepare_geneomes f…
pinin4fjords Mar 13, 2024
19e84bc
Add extra options params for ribotish
pinin4fjords Mar 14, 2024
62fd27c
Document new params
pinin4fjords Mar 14, 2024
ffbc79b
Prettier
pinin4fjords Mar 14, 2024
ed7d6fa
simplify example csv
pinin4fjords Mar 15, 2024
838c973
Remove hisat2 references (for now)
pinin4fjords Mar 15, 2024
b3921bd
Merge pull request #39 from nf-core/install_ribotish
pinin4fjords Mar 15, 2024
0ac039c
Add a full test profile
pinin4fjords Mar 18, 2024
998240d
Install ribotricer
pinin4fjords Mar 18, 2024
36b2b44
skip ribotricer in test profile
pinin4fjords Mar 18, 2024
6ea7c8b
Appease eclint
pinin4fjords Mar 18, 2024
b69906f
Update schema
pinin4fjords Mar 18, 2024
20ba16a
Fix linting
pinin4fjords Mar 18, 2024
0562c85
Temporary fix to test data
pinin4fjords Mar 18, 2024
b3f4d1a
Update CHANGELOG
pinin4fjords Mar 18, 2024
8a39dbb
Update ribotish modules
pinin4fjords Mar 18, 2024
4f8015a
skip ribotricer in nf-test
pinin4fjords Mar 18, 2024
c9ef8d2
Update README, CITATIONS
pinin4fjords Mar 18, 2024
bab78ac
Refine publishing locations
pinin4fjords Mar 18, 2024
3f4b739
Update output.md
pinin4fjords Mar 18, 2024
8ad4081
syntax fix
pinin4fjords Mar 18, 2024
78dbd47
fix profile details
pinin4fjords Mar 18, 2024
aa4f09e
Reinstate test data path
pinin4fjords Mar 18, 2024
ce7c22a
Merge branch 'ribotricer_orf_prediction' of github.com:nf-core/ribose…
pinin4fjords Mar 18, 2024
ffc8ee8
[skip ci] add link to credits
pinin4fjords Mar 19, 2024
003b248
Tweak full test profile
pinin4fjords Mar 21, 2024
a1cc1d8
increase timeout for star
pinin4fjords Mar 21, 2024
7fbfdce
Remove requirement for fasta in schema
pinin4fjords Apr 3, 2024
4e18a8a
Doc fix
pinin4fjords Apr 3, 2024
05cdad2
Prettier
pinin4fjords Apr 3, 2024
5ae9054
Merge pull request #40 from nf-core/ribotricer_orf_prediction
pinin4fjords Apr 3, 2024
adf1d10
Amend credits statement
FelixKrueger Apr 4, 2024
9f2403f
Merge pull request #41 from nf-core/credits
FelixKrueger Apr 4, 2024
c256372
Add quantification-related components
pinin4fjords Apr 5, 2024
4c153c6
Update CHANGELOG
pinin4fjords Apr 5, 2024
8d4a72d
Configure and document quantification outputs
pinin4fjords Apr 5, 2024
f985ba4
Appease eclint
pinin4fjords Apr 5, 2024
644d1f3
pre commit fixes
pinin4fjords Apr 5, 2024
5560996
Update CHANGELOG.md
pinin4fjords Apr 8, 2024
fda4028
Merge pull request #42 from nf-core/readd_quantification
pinin4fjords Apr 8, 2024
4efae35
Translational efficiency working
pinin4fjords Apr 9, 2024
18e69f4
Documentation updates
pinin4fjords Apr 9, 2024
8cdad8d
Bump anota2seq/anota2seqrun
pinin4fjords Apr 9, 2024
765fd7c
Update CHANGELOG
pinin4fjords Apr 9, 2024
42ca77b
Fix full profile
pinin4fjords Apr 9, 2024
4ea9e47
Add citation, versions for anota2seq
pinin4fjords Apr 10, 2024
398c228
Fix lack of fastqc in multiqc report
pinin4fjords Apr 10, 2024
8b0e5e9
update changelog
pinin4fjords Apr 10, 2024
fcfc6b6
Merge pull request #43 from nf-core/translational_efficiency
pinin4fjords Apr 10, 2024
2d1a34f
Merge branch 'dev' into fix_fastqc
pinin4fjords Apr 10, 2024
81a27fd
Merge pull request #44 from nf-core/fix_fastqc
pinin4fjords Apr 10, 2024
a31861b
Correct changelog
pinin4fjords Apr 10, 2024
51ae8b9
Update CI
pinin4fjords Apr 10, 2024
4da2595
Strip unused aligners etc
pinin4fjords Apr 10, 2024
4d2d1ac
Correct other CI components
pinin4fjords Apr 10, 2024
d147cc7
Update CHANGELOG
pinin4fjords Apr 10, 2024
4c53fc4
Link credited people to GitHub
pinin4fjords Apr 11, 2024
002a7cd
Remove some TODOs, final unused params
pinin4fjords Apr 11, 2024
b1fd885
Remove debugging line
pinin4fjords Apr 11, 2024
a4a64e3
Merge pull request #45 from nf-core/misc_fixes
pinin4fjords Apr 11, 2024
aaa04c6
bump versions
pinin4fjords Apr 11, 2024
3ef3abe
Bump components
pinin4fjords Apr 11, 2024
ec2e481
Add missing description
pinin4fjords Apr 11, 2024
7d8e662
Update CHANGELOG
pinin4fjords Apr 11, 2024
52aeeb5
Merge pull request #46 from nf-core/prerelease_v1.0.0
FelixKrueger Apr 11, 2024
5599599
Remove stub option from download in CI
pinin4fjords Apr 11, 2024
dbfb14c
Update CHANGELOG
pinin4fjords Apr 11, 2024
56b00d2
Merge pull request #48 from nf-core/disable_download_stub
pinin4fjords Apr 11, 2024
323ccb7
Add CI fix from @adamrtalbot
pinin4fjords Apr 11, 2024
4761739
CI should not work on pushes- breaks CI python script
pinin4fjords Apr 11, 2024
4b69e63
Add CI fix from @adamrtalbot
pinin4fjords Apr 11, 2024
f0cc13b
CI should not work on pushes- breaks CI python script
pinin4fjords Apr 11, 2024
f0f819a
update changelog
pinin4fjords Apr 11, 2024
4d533fb
update changelog
pinin4fjords Apr 11, 2024
dfb6d56
Merge pull request #49 from nf-core/fix_ci
pinin4fjords Apr 12, 2024
e48b62b
Merge branch 'dev' of github.com:nf-core/riboseq into dev
pinin4fjords Apr 12, 2024
5c51ef9
Update download CI- see https://nfcore.slack.com/archives/C04QR0T3G3H…
pinin4fjords Apr 12, 2024
e228313
Address JackCurragh review comments
pinin4fjords Apr 12, 2024
e966136
update changelog
pinin4fjords Apr 12, 2024
5efe929
changed logos to the custom w/ ribosome
JackCurragh Apr 12, 2024
be8c220
Removed at @maxulysse request
pinin4fjords Apr 12, 2024
6683f8f
@FelixKrueger suggestions
pinin4fjords Apr 12, 2024
a867998
Fix_unchanged
JackCurragh Apr 12, 2024
2ba4a5e
Ribo-Seq to Ribo-seq
pinin4fjords Apr 12, 2024
d2f35d3
Remove null index options- problematic in Platform
pinin4fjords Apr 12, 2024
637de26
reset using --fix
JackCurragh Apr 12, 2024
c237192
update logos again
JackCurragh Apr 12, 2024
fe07d41
ignore new logos in files_unchanged
JackCurragh Apr 12, 2024
d0ac866
Increase retries
pinin4fjords Apr 12, 2024
95e4fa4
Merge pull request #51 from nf-core/logos
FelixKrueger Apr 12, 2024
8c3052f
Update CHANGELOG.md
FelixKrueger Apr 12, 2024
bda7364
updated changelog
JackCurragh Apr 12, 2024
e17ec3f
organised PRs into sections
JackCurragh Apr 12, 2024
80d4f99
Update copyright
pinin4fjords Apr 12, 2024
52174ad
prettier
pinin4fjords Apr 12, 2024
b707492
Merge pull request #52 from nf-core/logo_changelog
pinin4fjords Apr 12, 2024
4451991
Merge branch 'v1.0.0_release_review_fixes' of github.com:nf-core/ribo…
pinin4fjords Apr 12, 2024
a56652d
Merge branch 'dev' into v1.0.0_release_review_fixes
pinin4fjords Apr 12, 2024
94db978
Update credits in README.md
pinin4fjords Apr 12, 2024
083e23e
Remove multiqc aligner subdir
pinin4fjords Apr 12, 2024
d10dbe2
Fix UMIs docs
pinin4fjords Apr 12, 2024
9249972
update author
pinin4fjords Apr 12, 2024
e3d45f4
Don't need subworkflows/local/prepare_genome/nextflow.config
pinin4fjords Apr 12, 2024
42a4b8a
Fix anota2seq versions
pinin4fjords Apr 12, 2024
d03b2a0
Add missing versions mixes
pinin4fjords Apr 12, 2024
0641734
Update CHANGELOG
pinin4fjords Apr 12, 2024
9f56a37
Merge pull request #50 from nf-core/v1.0.0_release_review_fixes
pinin4fjords Apr 12, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Binary file removed .cache/nfcore/cache_3.8.9/github_info.sqlite
Binary file not shown.
Empty file removed .cache/pre-commit/.lock
Empty file.
2 changes: 0 additions & 2 deletions .cache/pre-commit/README

This file was deleted.

Binary file removed .cache/pre-commit/db.db
Binary file not shown.
49 changes: 0 additions & 49 deletions .cache/pre-commit/pre-commit.log

This file was deleted.

1 change: 0 additions & 1 deletion .cache/pre-commit/repo4z5c_5i5
Submodule repo4z5c_5i5 deleted from 50c547
1 change: 0 additions & 1 deletion .cache/pre-commit/repop53w_kpk
Submodule repop53w_kpk deleted from 50c547
1 change: 0 additions & 1 deletion .config/nfcore/nf-core/modules
Submodule modules deleted from 499265
11 changes: 2 additions & 9 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,15 @@
"name": "nfcore",
"image": "nfcore/gitpod:latest",
"remoteUser": "gitpod",
"runArgs": ["--privileged"],

// Configure tool-specific properties.
"customizations": {
// Configure properties specific to VS Code.
"vscode": {
// Set *default* container specific settings.json values on container create.
"settings": {
"python.defaultInterpreterPath": "/opt/conda/bin/python",
"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.formatting.autopep8Path": "/opt/conda/bin/autopep8",
"python.formatting.yapfPath": "/opt/conda/bin/yapf",
"python.linting.flake8Path": "/opt/conda/bin/flake8",
"python.linting.pycodestylePath": "/opt/conda/bin/pycodestyle",
"python.linting.pydocstylePath": "/opt/conda/bin/pydocstyle",
"python.linting.pylintPath": "/opt/conda/bin/pylint"
"python.defaultInterpreterPath": "/opt/conda/bin/python"
},

// Add the IDs of extensions you want installed when the container is created.
Expand Down
15 changes: 14 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,20 @@ end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset
indent_size = unset
[/subworkflows/nf-core/**]
charset = unset
end_of_line = unset
insert_final_newline = unset
trim_trailing_whitespace = unset
indent_style = unset

[/assets/email*]
indent_size = unset

# ignore Readme
[README.md]
indent_style = unset

# ignore python
[*.{py,md}]
indent_style = unset
9 changes: 8 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ 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 ;)

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

## Contribution workflow
Expand All @@ -25,6 +26,12 @@ If you're not used to this workflow with git, you can start with some [docs from

## Tests

You have the option to test your changes locally by running the pipeline. For receiving warnings about process selectors and other `debug` information, it is recommended to use the debug profile. Execute all the tests with the following command:

```bash
nf-test test --profile debug,test,docker --verbose
```

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.

Expand Down Expand Up @@ -85,7 +92,7 @@ Once there, use `nf-core schema build` to add to `nextflow_schema.json`.

Sensible defaults for process resource requirements (CPUs / memory / time) for a process should be defined in `conf/base.config`. These should generally be specified generic with `withLabel:` selectors so they can be shared across multiple processes/steps of the pipeline. A nf-core standard set of labels that should be followed where possible can be seen in the [nf-core pipeline template](https://github.com/nf-core/tools/blob/master/nf_core/pipeline-template/conf/base.config), which has the default process as a single core-process, and then different levels of multi-core configurations for increasingly large memory requirements defined with standardised labels.

The process resources can be passed on to the tool dynamically within the process with the `${task.cpu}` and `${task.memory}` variables in the `script:` block.
The process resources can be passed on to the tool dynamically within the process with the `${task.cpus}` and `${task.memory}` variables in the `script:` block.

### Naming schemes

Expand Down
3 changes: 2 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/ribo
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/riboseq/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/riboseq _branch_ on the [nf-core/test-datasets](https://github.com/nf-core/test-datasets) repository.
- [ ] Make sure your code lints (`nf-core lint`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
- [ ] Ensure the test suite passes (`nf-test test main.nf.test -profile test,docker`).
- [ ] Check for unexpected warnings in debug mode (`nextflow run . -profile debug,test,docker --outdir <OUTDIR>`).
- [ ] Usage Documentation in `docs/usage.md` is updated.
- [ ] Output Documentation in `docs/output.md` is updated.
- [ ] `CHANGELOG.md` is updated.
Expand Down
Loading
Loading