From 659fa0bc733b298724712bba50575ea97d56e6d6 Mon Sep 17 00:00:00 2001 From: MacBook Air Date: Thu, 20 Feb 2025 17:04:09 -0800 Subject: [PATCH 1/2] docs: update fusionreport score calculation documentation - Add detailed explanation of new scoring system - Document 80/20 weight distribution between tool detection and database hits - Add formula for score calculation --- docs/output.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/output.md b/docs/output.md index ad3c78e3..1664babf 100644 --- a/docs/output.md +++ b/docs/output.md @@ -264,13 +264,17 @@ 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) + - Calculated as: (number of tools detecting the fusion) / (number of tools actually used) + - This reflects how many of the active tools found the fusion -All tools have the same weight. +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 From 214b70b52ee1c9e538806ec8a831513ad9b26e9f Mon Sep 17 00:00:00 2001 From: MacBook Air Date: Tue, 25 Feb 2025 11:43:33 -0800 Subject: [PATCH 2/2] Apply pre-commit fixes and update changelog --- CHANGELOG.md | 1 + docs/output.md | 1 + 2 files changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cdc774e1..c3220386 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/docs/output.md b/docs/output.md index 1664babf..3698f7a6 100644 --- a/docs/output.md +++ b/docs/output.md @@ -267,6 +267,7 @@ The weights for databases are as follows: The score is calculated using two components: 1. Tool Detection (80% of total score) + - Calculated as: (number of tools detecting the fusion) / (number of tools actually used) - This reflects how many of the active tools found the fusion