Skip to content

Documentation: Add Study View Data Binning Algorithm Overview #11457

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

addiiiti
Copy link

Pull Request Description:

This PR introduces a comprehensive documentation file detailing the current Java-based data binning algorithm used in cBioPortal’s Study View. The documentation outlines the binning methodology, implementation workflow, key components, and potential areas for optimization.

Key Additions:

  • A new Markdown file: docs/study_view_binning_algorithm.md
  • Explanation of binning strategies: quartile-based, median-split, and custom binning
  • Breakdown of the current Java implementation, including key classes and functions
  • Identification of performance bottlenecks and memory constraints
  • Recommendations for improving efficiency, particularly by leveraging ClickHouse for in-database binning

Purpose & Relevance:

This documentation serves as a reference for developers contributing to the planned migration of binning logic from Java to SQL. It ensures a clear understanding of the existing implementation and provides a foundation for future optimizations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant