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.

Sign up for GitHub

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

docs: update fusionreport score calculation documentation Resolves nf-core#555 #620

Merged
merged 2 commits into from
Feb 26, 2025
Merged

docs: update fusionreport score calculation documentation Resolves nf-core#555 #620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
659fa0b
docs: update fusionreport score calculation documentation
dacotah03 Feb 21, 2025
214b70b
Apply pre-commit fixes and update changelog
dacotah03 Feb 25, 2025
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add nf-test to local subworkflow: `STARFUSION_WORKFLOW`. [#597](https://github.com/nf-core/rnafusion/pull/597)
- Add nf-test to local module: `FUSIONINSPECTOR`. [#601](https://github.com/nf-core/rnafusion/pull/601)
- Add nf-test to local subworkflow: `FUSIONREPORT_WORKFLOW`. [#607](https://github.com/nf-core/rnafusion/pull/607)
- Updated documentation for fusion-report score calculation to reflect 80/20 weight distribution between tool detection and database hits [#620](https://github.com/nf-core/rnafusion/pull/620)

### Changed

Expand Down
15 changes: 10 additions & 5 deletions docs/output.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,13 +264,18 @@ The weights for databases are as follows:
- MITELMAN (50)
- FusionGDB2 (0)

The final formula for calculating score is:
The score is calculated using two components:

$$
score = 0.5 * \sum_{tool}^{tools} f(fusion, tool)*w(tool) + 0.5 * \sum_{db}^{dbs} g(fusion, db)*w(db)
$$
1. Tool Detection (80% of total score)

All tools have the same weight.
- Calculated as: (number of tools detecting the fusion) / (number of tools actually used)
- This reflects how many of the active tools found the fusion

2. Database Hits (20% of total score)
- Based on database matches using weights above
- Calculated as: (number of database hits) / (total possible database hits)

Final score = (0.8 × Tool Detection Score) + (0.2 × Database Hits Score)

### Salmon

Expand Down