Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1182 commits
Select commit Hold shift + click to select a range
9d3fb7e
update ctat test
rannick Jul 26, 2025
de664dc
update starfusion detect test
rannick Jul 26, 2025
7efcefe
update fusioninspector
rannick Jul 28, 2025
2196478
change logic
rannick Jul 28, 2025
be81566
Merge branch 'no_fusions' of https://github.com/nf-core/rnafusion int…
rannick Jul 28, 2025
3613777
update fusioninspector test
rannick Jul 28, 2025
a3843ee
udpate logic
rannick Jul 28, 2025
2203644
update fusioncatcher test
rannick Jul 28, 2025
dd3171a
recreate transcript version from Transcript id
rannick Jul 28, 2025
c9b73a6
Merge pull request #702 from nf-core/nf-core-template-merge-3.3.2
rannick Jul 29, 2025
5ee8b5e
fix merge conflict
rannick Jul 29, 2025
34c96ce
Merge branch 'dev' into s3-references
nvnieuwk Jul 29, 2025
f805cb8
fix linting
nvnieuwk Jul 29, 2025
c8468af
update vcf
rannick Jul 29, 2025
95d81c1
update vcf
rannick Jul 29, 2025
7341a69
update changelog
rannick Jul 29, 2025
52f37b1
Merge branch 'dev' into no_fusions
rannick Jul 29, 2025
5833f62
update build tests
nvnieuwk Jul 29, 2025
a684b1c
test: fix fusionreport stub test
atrigila Jul 29, 2025
6d3e9a2
fix build snap
nvnieuwk Jul 30, 2025
6c5d4b7
Merge pull request #718 from nf-core/update_metro_map
rannick Jul 30, 2025
71eaf4d
Merge branch 'dev' into fix_vcf_collect
rannick Jul 30, 2025
2da05e3
test: fix starfusion test
atrigila Jul 30, 2025
64d50f2
fix .nftignore
nvnieuwk Jul 30, 2025
709a0d6
Merge pull request #723 from atrigila/refactor_sbwf_fusionreport
atrigila Jul 30, 2025
06438c9
Merge branch 'dev' into s3-references
nvnieuwk Jul 31, 2025
54ba946
fix build test again
nvnieuwk Jul 31, 2025
74dd526
Merge branch 's3-references' of github.com:nvnieuwk/nf-core-rnafusion…
nvnieuwk Jul 31, 2025
b2c8ae0
Merge branch 'dev' into fix_vcf_collect
atrigila Jul 31, 2025
3043560
Update `test_build` to use reduced Pfam and Dfam files
delfiterradas Aug 4, 2025
7b0b2d0
Small change to trigger test
delfiterradas Aug 4, 2025
5f33759
Update `CHANGELOG.md`
delfiterradas Aug 4, 2025
7f92ad1
Update tests for local modules to use reduced Pfam and Dfam files
delfiterradas Aug 4, 2025
d20c727
Update README.md
nvnieuwk Aug 5, 2025
5455ae8
Update docs/usage.md
nvnieuwk Aug 5, 2025
07f61c9
fix lint issues
nvnieuwk Aug 5, 2025
3f5ca6e
fix nf-core lint
nvnieuwk Aug 5, 2025
e1aaa68
improve non-buildable references handling
nvnieuwk Aug 5, 2025
0da9176
feat: add rrnatranscripts from nf-core
atrigila Aug 5, 2025
da9f104
feat: add agat/convertgff2bed from nf-core
atrigila Aug 5, 2025
9cc949f
feat: replace local rrnatranscripts for nf-core versions
atrigila Aug 5, 2025
bb19240
feat: add bioawk module
atrigila Aug 5, 2025
a23efe7
chore: replace rrnatranscripts for bioawk
atrigila Aug 5, 2025
d455427
chore: remove unused modules and scripts
atrigila Aug 5, 2025
8750a11
fix build test inputs
nvnieuwk Aug 6, 2025
7a95f92
Merge pull request #717 from nvnieuwk/s3-references
nvnieuwk Aug 6, 2025
20dfd26
Merge branch 'dev' into fix_vcf_collect
rannick Aug 6, 2025
8205a8e
test: update snapshot
atrigila Aug 6, 2025
1ab3e8a
Merge branch 'dev' into getrrnatranscripts_nfcore
atrigila Aug 6, 2025
ecadb91
Merge branch 'dev' into dev
delfiterradas Aug 6, 2025
16a22af
Merge pull request #733 from delfiterradas/dev
delfiterradas Aug 6, 2025
8c5fdbf
Merge branch 'dev' into getrrnatranscripts_nfcore
atrigila Aug 6, 2025
b245a2c
Merge branch 'dev' into fix_vcf_collect
rannick Aug 7, 2025
773bc65
update snap
rannick Aug 7, 2025
2dbc1e6
remove usage of cosmic in tests
rannick Aug 7, 2025
292e682
apply some fixes to the configs
nvnieuwk Aug 7, 2025
b8eec28
fix awstest params
nvnieuwk Aug 7, 2025
25f4db9
Merge pull request #738 from nvnieuwk/fix/test_full
rannick Aug 7, 2025
c00099b
fix merge conflicts
rannick Aug 7, 2025
3c633f1
remove typo
rannick Aug 7, 2025
1bfe820
Merge pull request #737 from nf-core/remove_cosmic_secret
rannick Aug 7, 2025
9ea86a0
update snap
rannick Aug 7, 2025
9ea3076
Merge branch 'dev' into fix_vcf_collect
rannick Aug 7, 2025
9e8c10a
Merge branch 'dev' into getrrnatranscripts_nfcore
atrigila Aug 7, 2025
05dce51
Merge pull request #726 from nf-core/fix_vcf_collect
rannick Aug 7, 2025
4a25a22
Merge branch 'dev' into no_fusions
rannick Aug 7, 2025
ae216a9
Merge branch 'dev' into getrrnatranscripts_nfcore
atrigila Aug 7, 2025
6144f66
remove arriba_download
atrigila Aug 7, 2025
30e7e72
Merge branch 'getrrnatranscripts_nfcore' of https://github.com/atrigi…
atrigila Aug 7, 2025
71fc45f
fix issues and add characters to fusioninspectore stub run so the dow…
rannick Aug 8, 2025
4f3f267
apply first updates
nvnieuwk Aug 8, 2025
449eab0
tests: update test build
atrigila Aug 8, 2025
79bb0db
test: update test stub snapshot
atrigila Aug 8, 2025
6d7e101
test: update test stub bam
atrigila Aug 8, 2025
991e355
docs: update changelog
atrigila Aug 8, 2025
f9f8553
chore: remove unused arriba download
atrigila Aug 8, 2025
4ed4ab3
chore: replace local arriba visualization for nf-core
atrigila Aug 8, 2025
82ab0f4
chore: replace local ctatsplicing for nf-core
atrigila Aug 8, 2025
f4cf3ef
chore: replace local fusioninspector for nf-core
atrigila Aug 8, 2025
0c1c493
chore: replace local for nf-core modules
atrigila Aug 8, 2025
ed7d88d
update snape
rannick Aug 8, 2025
777073c
chore: replace local for nf-core starfusion detect
atrigila Aug 8, 2025
66b67b1
chore: replace local for nf-core starfusion detect
atrigila Aug 8, 2025
e05eaf3
update usage.md
nvnieuwk Aug 8, 2025
dae121c
pre-commit
nvnieuwk Aug 8, 2025
3d06bc8
nf-core lint
nvnieuwk Aug 8, 2025
5d29378
chore: import nf-core modules
atrigila Aug 8, 2025
6249d76
docs: updated changelog
atrigila Aug 8, 2025
cfac4cb
fix output docs
nvnieuwk Aug 11, 2025
acfb48b
changelog
nvnieuwk Aug 11, 2025
332a20c
Add test for `vcf_collect` module
delfiterradas Aug 13, 2025
86cb5c5
Add snapshot
delfiterradas Aug 13, 2025
074ea3f
Update CHANGELOG.md
delfiterradas Aug 13, 2025
5fe1172
Merge pull request #745 from delfiterradas/dev
delfiterradas Aug 13, 2025
c3d7044
test: update snapshot
atrigila Aug 18, 2025
75a2cdd
fix: make changes to avoid module failure
atrigila Aug 18, 2025
f7be12e
fix: patch module temporarily until changes are made in nf-core
atrigila Aug 18, 2025
193e96d
Merge pull request #740 from atrigila/arriba_visualization_nf-core
atrigila Aug 19, 2025
ade0511
update starfusion detect
nvnieuwk Aug 20, 2025
5747e6e
fix: detect `transcript_type` in gtf
atrigila Aug 20, 2025
b3cd9a9
docs: update changelog
atrigila Aug 20, 2025
ceec304
Merge pull request #748 from nvnieuwk/fix/starfusion-optional-output
nvnieuwk Aug 21, 2025
342d4fa
add arriba fusion back to fusioninspector input
nvnieuwk Aug 21, 2025
006b5cd
fix null params issues
nvnieuwk Aug 21, 2025
dfbb02c
Merge pull request #750 from nvnieuwk/fix/arrriba-fusioninspector
nvnieuwk Aug 21, 2025
e037c4a
Merge pull request #751 from nvnieuwk/fix/null-reference-params
nvnieuwk Aug 21, 2025
310403a
Merge pull request #749 from atrigila/transcript_type
atrigila Aug 21, 2025
19887f6
Update docs/usage.md
nvnieuwk Aug 21, 2025
5a38668
refact: replace local `trim_workflow` for nf-core subworkflow with sa…
atrigila Aug 21, 2025
0d0c739
fix: replace for new module names in config
atrigila Aug 21, 2025
fcbf9db
test: update snapshot
atrigila Aug 21, 2025
5560282
style: improve ifempty usage
atrigila Aug 22, 2025
82dbc7c
chore: remove unused parameters, add new trim params
atrigila Aug 22, 2025
cc302d6
chore: remove unused file
atrigila Aug 22, 2025
889c219
docs: update changelog
atrigila Aug 22, 2025
6057891
chore: remove non-existent test
atrigila Aug 22, 2025
8205a98
intermetiate snap update
rannick Aug 25, 2025
d6e80c9
dev merge
rannick Aug 25, 2025
766b0f8
update snap
rannick Aug 25, 2025
a2335c2
Add test for fusioninspector subworkflow
delfiterradas Aug 25, 2025
cf5802e
update snap
rannick Aug 26, 2025
ace5d0c
Update test
delfiterradas Aug 26, 2025
8822e21
Update gitignore
delfiterradas Aug 26, 2025
e8b1eeb
Update tags
delfiterradas Aug 26, 2025
e756a33
Update .gitignore
delfiterradas Aug 26, 2025
c2cad26
Update nextflow.config
delfiterradas Aug 26, 2025
e839eab
Update nextflow.config
delfiterradas Aug 26, 2025
f8a5790
Change to nf-core subworkflow of `fastq_align_star`
delfiterradas Aug 26, 2025
baf957e
Add emits to fastq_align_star subworkflow
delfiterradas Aug 26, 2025
859edab
Update stub test
delfiterradas Aug 27, 2025
5071899
Patch subworkflows to avoid lint failures
delfiterradas Aug 27, 2025
8282dc0
Update santools/sort and keep original subworkflow bam_sort_stats_sam…
delfiterradas Aug 27, 2025
4719efc
Use smaller dfam and pfam files in tests
delfiterradas Aug 27, 2025
6c93731
Update nextflow.config to use samller dfam and pfam files in tests
delfiterradas Aug 27, 2025
9c560e8
Update nextflow.config
delfiterradas Aug 27, 2025
e3e4c13
Update stub test snapshot
delfiterradas Aug 27, 2025
8a9d157
Replace modules in test for QC_WORKFLOW
delfiterradas Aug 27, 2025
605cbc7
update qc workflow test and snap
rannick Aug 28, 2025
225aeb9
Update workflows/rnafusion.nf
delfiterradas Aug 28, 2025
88c9932
Update main.nf.test
delfiterradas Aug 28, 2025
d82593c
Update main.nf.test.snap
delfiterradas Aug 28, 2025
c59cd57
Update CHANGELOG.md
delfiterradas Aug 28, 2025
66077fb
test: update snapshot
atrigila Aug 28, 2025
a6e5f70
Merge branch 'fusioninspector_workflow' of https://github.com/delfite…
delfiterradas Aug 28, 2025
b771b47
Update nf-test to avoid failure due to unstable file
delfiterradas Aug 28, 2025
1acb395
Update CHANGELOG.md
delfiterradas Aug 28, 2025
f9247cd
Merge pull request #752 from atrigila/replace_trim_sbwf_for_nf-core
atrigila Aug 29, 2025
fc66372
Merge branch 'dev' into fastq_align_star
delfiterradas Aug 29, 2025
b8e59d4
Fix modules.json
delfiterradas Aug 29, 2025
5e0383b
Fix main.nf.test.snap
delfiterradas Aug 29, 2025
82042b4
Merge pull request #756 from delfiterradas/fastq_align_star
delfiterradas Aug 29, 2025
31596f4
Merge branch 'dev' into fusioninspector_workflow
atrigila Aug 29, 2025
6463dd4
Merge pull request #753 from delfiterradas/fusioninspector_workflow
delfiterradas Aug 29, 2025
21e21b1
fix merge conflicts and use branching instead of if statements
rannick Sep 1, 2025
a347208
reshuffling
rannick Sep 1, 2025
fcfe9b1
Update CHANGELOG.md
nvnieuwk Sep 1, 2025
021f5f8
Update docs/output.md
nvnieuwk Sep 1, 2025
2321077
Update docs/output.md
nvnieuwk Sep 1, 2025
71fb652
Update README.md
nvnieuwk Sep 1, 2025
69a133c
Update README.md
nvnieuwk Sep 1, 2025
9888efb
Update docs/output.md
nvnieuwk Sep 1, 2025
f1b4a6f
add missing links
nvnieuwk Sep 1, 2025
6d7c8ae
Merge branch 'update/docs' of github.com:nvnieuwk/nf-core-rnafusion i…
nvnieuwk Sep 1, 2025
ada6a0d
apply suggestions from comment
nvnieuwk Sep 1, 2025
4ff285b
Merge branch 'dev' into update/docs
nvnieuwk Sep 1, 2025
52b43dd
chore: replace local for nf-core subworkflow
atrigila Sep 2, 2025
d43cf51
remove baseDir in rrna transcript
nvnieuwk Sep 2, 2025
59fcd54
Update subworkflows/local/fusioninspector_workflow/main.nf
rannick Sep 2, 2025
08c7dec
Update subworkflows/local/fusioninspector_workflow/main.nf
rannick Sep 2, 2025
ddd26f2
chore: replace gtftorefflat for nf-core module
atrigila Sep 2, 2025
ddbfd78
fix linting
nvnieuwk Sep 2, 2025
70977ec
Merge branch 'update/docs' of github.com:nvnieuwk/nf-core-rnafusion i…
nvnieuwk Sep 2, 2025
ea84891
fix config
nvnieuwk Sep 2, 2025
36221f8
update
rannick Sep 2, 2025
d2a4764
remove zombie line
rannick Sep 2, 2025
eeaf8bb
fix lint
nvnieuwk Sep 2, 2025
51f295a
Merge pull request #758 from atrigila/migrate_sbwf_stringtie
atrigila Sep 2, 2025
84fb1f0
Merge pull request #741 from nvnieuwk/update/docs
nvnieuwk Sep 2, 2025
e765480
update snap
rannick Sep 2, 2025
9dddc25
udpate snap bam
rannick Sep 2, 2025
e7c12b0
change operator
rannick Sep 3, 2025
34d147e
Update docs/usage.md
rannick Sep 3, 2025
ad9ca49
Merge branch 'dev' into update_doc
rannick Sep 3, 2025
d573bce
Merge pull request #719 from nf-core/update_doc
rannick Sep 3, 2025
11303bf
udpate modules
rannick Sep 3, 2025
aa2b30c
Merge branch 'dev' into no_fusions
rannick Sep 3, 2025
920313a
update subwfs, solve linting issues
rannick Sep 3, 2025
5276450
prettier
rannick Sep 3, 2025
9931490
update snaps
rannick Sep 3, 2025
0fdf38a
update snap
rannick Sep 4, 2025
261d8d8
update qc workflow test
rannick Sep 5, 2025
3901adb
feat: add missing PDF and HTML report patterns to tower.yml
pinin4fjords Sep 5, 2025
a8262a8
update build snap
rannick Sep 5, 2025
49c4231
Remove MultiQC PDF plots pattern
pinin4fjords Sep 5, 2025
7dfe4eb
Remove duplicate MultiQC report pattern
pinin4fjords Sep 5, 2025
44e9277
Remove redundant fusionreport index pattern
pinin4fjords Sep 5, 2025
fc01d42
Add missing PDF and HTML report patterns to tower.yml
pinin4fjords Sep 5, 2025
38f5832
prettier
rannick Sep 5, 2025
b1c98ff
Revert Picard PDF display name change
pinin4fjords Sep 5, 2025
126c07e
Revert unnecessary Picard PDF pattern change
pinin4fjords Sep 5, 2025
74ac1f9
Merge pull request #762 from nf-core/update-tower-yml-reports
pinin4fjords Sep 5, 2025
d8dd843
Merge branch 'dev' into no_fusions
rannick Sep 8, 2025
73113eb
fix fusioninspector workflow
rannick Sep 9, 2025
1141d24
Merge branch 'no_fusions' of https://github.com/nf-core/rnafusion int…
rannick Sep 9, 2025
bd3fddc
update build snap
rannick Sep 9, 2025
82608dd
qc test fixes
rannick Sep 9, 2025
901b87f
Merge branch 'dev' into update_modules2
rannick Sep 9, 2025
3656a72
update changelog
rannick Sep 9, 2025
f3e822c
Merge branch 'update_modules2' of https://github.com/nf-core/rnafusio…
rannick Sep 9, 2025
46e2434
Merge pull request #759 from nf-core/update_modules2
rannick Sep 9, 2025
2c710b6
Merge branch 'dev' into no_fusions
rannick Sep 9, 2025
b1c222c
Merge pull request #714 from nf-core/no_fusions
rannick Sep 9, 2025
94a3ef2
fix bed format
rannick Sep 9, 2025
4d6ff58
update changelog
rannick Sep 9, 2025
a81c9bb
update changelog
rannick Sep 9, 2025
7c24849
Merge pull request #763 from nf-core/fix_bed_format
rannick Sep 9, 2025
33978a8
fix fusioncatcher hardlinks
nvnieuwk Sep 10, 2025
317c1a7
add pr number
nvnieuwk Sep 10, 2025
6fe4a50
pre-commit
nvnieuwk Sep 10, 2025
51170b6
update snap
nvnieuwk Sep 10, 2025
d20677a
Merge pull request #764 from nvnieuwk/fusioncatcher-bump
nvnieuwk Sep 10, 2025
0081964
version bumped to 4.0.0
rannick Sep 10, 2025
559c8c6
prettier
rannick Sep 10, 2025
f932e4a
update version in snap
rannick Sep 10, 2025
e5f4c25
Merge pull request #765 from rannick/4_0_0
rannick Sep 11, 2025
e0ca5e7
remove conda from test on master
rannick Sep 11, 2025
ec90064
Merge branch 'dev' into remove_conda_from_test
rannick Sep 11, 2025
e246e82
Merge pull request #767 from rannick/remove_conda_from_test
rannick Sep 11, 2025
eefca66
update download action: remove non-stub run
rannick Sep 15, 2025
f0e91d8
Merge branch 'dev' into update_download_action
rannick Sep 15, 2025
390e36e
Merge pull request #768 from rannick/update_download_action
rannick Sep 15, 2025
135cd0f
Update subworkflows/local/fusioninspector_workflow/main.nf
rannick Sep 16, 2025
a7f86b7
Update workflows/rnafusion.nf
rannick Sep 16, 2025
64e255e
Update docs/usage.md
rannick Sep 16, 2025
154f592
remove duplicat multiqc
rannick Sep 16, 2025
e413486
add author and licence information
rannick Sep 16, 2025
648b5a3
remove unnecessary map
rannick Sep 16, 2025
a601b36
apply suggestion from code review
rannick Sep 16, 2025
dfe5781
add warning about conda
rannick Sep 16, 2025
91a372e
replace by agat
rannick Sep 16, 2025
cf9ce87
Merge branch 'dev' into code_review
rannick Sep 16, 2025
440c673
remove mentions of conda
rannick Sep 16, 2025
1ce3aaa
add Delfina Terradas to the contributor list
rannick Sep 17, 2025
cea3630
update description of fastqc and multiqc outputs (from template)
rannick Sep 17, 2025
261ac83
Merge branch 'code_review' of https://github.com/rannick/rnafusion in…
rannick Sep 17, 2025
28742bc
Update docs/output.md
rannick Sep 18, 2025
3d69168
remove commented out outdated comment
rannick Sep 18, 2025
bbcb3bd
add info on seq_center and seq_platform
rannick Sep 18, 2025
73a5cd9
Merge branch 'dev' into code_review
rannick Sep 18, 2025
52854c9
Merge pull request #770 from rannick/code_review
rannick Sep 18, 2025
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
  •  
  •  
  •  
37 changes: 0 additions & 37 deletions .editorconfig

This file was deleted.

12 changes: 12 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Maintainers
* @rannick @nvnieuwk @atrigila
*.nf.test* @rannick @nvnieuwk @atrigila
.github/workflows/ @rannick @nvnieuwk @atrigila

# Subworkflows
subworkflows/nf-core/* @rannick @nvnieuwk @atrigila
subworkflows/local/* @rannick @nvnieuwk @atrigila

# Modules
modules/nf-core/* @rannick @nvnieuwk @atrigila
modules/local/* @rannick @nvnieuwk @atrigila
26 changes: 13 additions & 13 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# nf-core/rnafusion: Contributing Guidelines
# `nf-core/rnafusion`: Contributing Guidelines

Hi there!
Many thanks for taking an interest in improving nf-core/rnafusion.
Expand All @@ -19,7 +19,7 @@ If you'd like to write some code for nf-core/rnafusion, the standard workflow is
1. Check that there isn't already an issue about your idea in the [nf-core/rnafusion issues](https://github.com/nf-core/rnafusion/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](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [nf-core/rnafusion repository](https://github.com/nf-core/rnafusion) to your GitHub account
3. Make the necessary changes / additions within your forked repository following [Pipeline conventions](#pipeline-contribution-conventions)
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).
4. Use `nf-core pipelines schema build` and add any new parameters to the pipeline JSON schema (requires [nf-core tools](https://github.com/nf-core/tools) >= 1.10).
5. 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/).
Expand All @@ -40,7 +40,7 @@ There are typically two types of tests that run:
### Lint tests

`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.
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 pipelines lint <pipeline-directory>` command.

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

Expand All @@ -55,42 +55,42 @@ These tests are run both with the latest available version of `Nextflow` and als

: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`.
- On your own fork, make a new branch `patch` based on `upstream/main` or `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.
- Open a pull-request from `patch` to `main`/`master` with the changes.

## Getting help

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

## Pipeline contribution conventions

To make the nf-core/rnafusion code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written.
To make the `nf-core/rnafusion` code and processing logic more understandable for new contributors and to ensure quality, we semi-standardise the way the code and other contributions are written.

### Adding a new step

If you wish to contribute a new step, please use the following coding standards:

1. Define the corresponding input channel into your new process from the expected previous process channel
1. Define the corresponding input channel into your new process from the expected previous process channel.
2. Write the process block (see below).
3. Define the output channel if needed (see below).
4. Add any new parameters to `nextflow.config` with a default (see below).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core schema build` tool).
5. Add any new parameters to `nextflow_schema.json` with help text (via the `nf-core pipelines schema build` tool).
6. Add sanity checks and validation for all relevant parameters.
7. Perform local tests to validate that the new code works as expected.
8. If applicable, add a new test command in `.github/workflow/ci.yml`.
8. If applicable, add a new test in the `tests` directory.
9. Update MultiQC config `assets/multiqc_config.yml` so relevant suffixes, file name clean up and module plots are in the appropriate order. If applicable, add a [MultiQC](https://https://multiqc.info/) module.
10. Add a description of the output files and if relevant any appropriate images from the MultiQC report to `docs/output.md`.

### Default values

Parameters should be initialised / defined with default values in `nextflow.config` under the `params` scope.
Parameters should be initialised / defined with default values within the `params` scope in `nextflow.config`.

Once there, use `nf-core schema build` to add to `nextflow_schema.json`.
Once there, use `nf-core pipelines schema build` to add to `nextflow_schema.json`.

### Default processes resource requirements

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.
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/main/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.cpus}` and `${task.memory}` variables in the `script:` block.

Expand All @@ -103,7 +103,7 @@ Please use the following naming schemes, to make it easy to understand what is g

### Nextflow version bumping

If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core bump-version --nextflow . [min-nf-version]`
If you are using a new feature from core Nextflow, you may bump the minimum required version of nextflow in the pipeline with: `nf-core pipelines bump-version --nextflow . [min-nf-version]`

### Images and figures

Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ body:

- [nf-core website: troubleshooting](https://nf-co.re/usage/troubleshooting)
- [nf-core/rnafusion pipeline documentation](https://nf-co.re/rnafusion/usage)

- type: textarea
id: description
attributes:
Expand Down
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Learn more about contributing: [CONTRIBUTING.md](https://github.com/nf-core/rnaf
- [ ] If you've fixed a bug or added code that should be tested, add tests!
- [ ] If you've added a new tool - have you followed the pipeline conventions in the [contribution docs](https://github.com/nf-core/rnafusion/tree/master/.github/CONTRIBUTING.md)
- [ ] If necessary, also make a PR on the nf-core/rnafusion _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 (`nf-test test main.nf.test -profile test,docker`). -->
- [ ] Make sure your code lints (`nf-core pipelines lint`).
- [ ] Ensure the test suite passes (`nextflow run . -profile test,docker --outdir <OUTDIR>`).
- [ ] 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.
Expand Down
69 changes: 69 additions & 0 deletions .github/actions/get-shards/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: "Get number of shards"
description: "Get the number of nf-test shards for the current CI job"
inputs:
max_shards:
description: "Maximum number of shards allowed"
required: true
paths:
description: "Component paths to test"
required: false
tags:
description: "Tags to pass as argument for nf-test --tag parameter"
required: false
outputs:
shard:
description: "Array of shard numbers"
value: ${{ steps.shards.outputs.shard }}
total_shards:
description: "Total number of shards"
value: ${{ steps.shards.outputs.total_shards }}
runs:
using: "composite"
steps:
- name: Install nf-test
uses: nf-core/setup-nf-test@v1
with:
version: ${{ env.NFT_VER }}
- name: Get number of shards
id: shards
shell: bash
run: |
# Run nf-test with dynamic parameter
nftest_output=$(nf-test test \
--profile +docker \
$(if [ -n "${{ inputs.tags }}" ]; then echo "--tag ${{ inputs.tags }}"; fi) \
--dry-run \
--ci \
--changed-since HEAD^) || {
echo "nf-test command failed with exit code $?"
echo "Full output: $nftest_output"
exit 1
}
echo "nf-test dry-run output: $nftest_output"
# Default values for shard and total_shards
shard="[]"
total_shards=0
# Check if there are related tests
if echo "$nftest_output" | grep -q 'No tests to execute'; then
echo "No related tests found."
else
# Extract the number of related tests
number_of_shards=$(echo "$nftest_output" | sed -n 's|.*Executed \([0-9]*\) tests.*|\1|p')
if [[ -n "$number_of_shards" && "$number_of_shards" -gt 0 ]]; then
shards_to_run=$(( $number_of_shards < ${{ inputs.max_shards }} ? $number_of_shards : ${{ inputs.max_shards }} ))
shard=$(seq 1 "$shards_to_run" | jq -R . | jq -c -s .)
total_shards="$shards_to_run"
else
echo "Unexpected output format. Falling back to default values."
fi
fi
# Write to GitHub Actions outputs
echo "shard=$shard" >> $GITHUB_OUTPUT
echo "total_shards=$total_shards" >> $GITHUB_OUTPUT
# Debugging output
echo "Final shard array: $shard"
echo "Total number of shards: $total_shards"
109 changes: 109 additions & 0 deletions .github/actions/nf-test/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
name: "nf-test Action"
description: "Runs nf-test with common setup steps"
inputs:
profile:
description: "Profile to use"
required: true
shard:
description: "Shard number for this CI job"
required: true
total_shards:
description: "Total number of test shards(NOT the total number of matrix jobs)"
required: true
paths:
description: "Test paths"
required: true
tags:
description: "Tags to pass as argument for nf-test --tag parameter"
required: false
runs:
using: "composite"
steps:
- name: Setup Nextflow
uses: nf-core/setup-nextflow@v2
with:
version: "${{ env.NXF_VERSION }}"

- name: Set up Python
uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5
with:
python-version: "3.13"

- name: Install nf-test
uses: nf-core/setup-nf-test@v1
with:
version: "${{ env.NFT_VER }}"
install-pdiff: true

- name: Setup apptainer
if: contains(inputs.profile, 'singularity')
uses: eWaterCycle/setup-apptainer@main

- name: Set up Singularity
if: contains(inputs.profile, 'singularity')
shell: bash
run: |
mkdir -p $NXF_SINGULARITY_CACHEDIR
mkdir -p $NXF_SINGULARITY_LIBRARYDIR

- name: Conda setup
if: contains(inputs.profile, 'conda')
uses: conda-incubator/setup-miniconda@505e6394dae86d6a5c7fbb6e3fb8938e3e863830 # v3
with:
auto-update-conda: true
conda-solver: libmamba
conda-remove-defaults: true

- name: Run nf-test
shell: bash
env:
NFT_WORKDIR: ${{ env.NFT_WORKDIR }}
run: |
nf-test test \
--profile=+${{ inputs.profile }} \
$(if [ -n "${{ inputs.tags }}" ]; then echo "--tag ${{ inputs.tags }}"; fi) \
--ci \
--changed-since HEAD^ \
--verbose \
--tap=test.tap \
--shard ${{ inputs.shard }}/${{ inputs.total_shards }}

# Save the absolute path of the test.tap file to the output
echo "tap_file_path=$(realpath test.tap)" >> $GITHUB_OUTPUT

- name: Generate test summary
if: always()
shell: bash
run: |
# Add header if it doesn't exist (using a token file to track this)
if [ ! -f ".summary_header" ]; then
echo "# 🚀 nf-test results" >> $GITHUB_STEP_SUMMARY
echo "" >> $GITHUB_STEP_SUMMARY
echo "| Status | Test Name | Profile | Shard |" >> $GITHUB_STEP_SUMMARY
echo "|:------:|-----------|---------|-------|" >> $GITHUB_STEP_SUMMARY
touch .summary_header
fi

if [ -f test.tap ]; then
while IFS= read -r line; do
if [[ $line =~ ^ok ]]; then
test_name="${line#ok }"
# Remove the test number from the beginning
test_name="${test_name#* }"
echo "| ✅ | ${test_name} | ${{ inputs.profile }} | ${{ inputs.shard }}/${{ inputs.total_shards }} |" >> $GITHUB_STEP_SUMMARY
elif [[ $line =~ ^not\ ok ]]; then
test_name="${line#not ok }"
# Remove the test number from the beginning
test_name="${test_name#* }"
echo "| ❌ | ${test_name} | ${{ inputs.profile }} | ${{ inputs.shard }}/${{ inputs.total_shards }} |" >> $GITHUB_STEP_SUMMARY
fi
done < test.tap
else
echo "| ⚠️ | No test results found | ${{ inputs.profile }} | ${{ inputs.shard }}/${{ inputs.total_shards }} |" >> $GITHUB_STEP_SUMMARY
fi

- name: Clean up
if: always()
shell: bash
run: |
sudo rm -rf /home/ubuntu/tests/
Loading
Loading