Skip to content

Improve README #20

@sdhutchins

Description

@sdhutchins

These are just a few suggestions I have that may help with the README.

  • Add a license badge.
  • Improve the description
    • Add links in the description to those tools and not that DITTO will be published or is being written
  • Add a screenshot of the app
  • Explain or mention before showing screenshot or after what can you search for: by gene? by variant? all?

I'd be happy to help here or review if needed.


A potential description

The DITTO web application offers a scientific platform for researchers to investigate deleterious variants, combining the DITTO deleteriousness score and ClinVar's reported significance to comprehensively assess variant impact.

DITTO uses an explainable neural network model enhanced by SHAP for transparent model predictions, ensuring clarity in understanding the functional implications of variants. It is rigorously trained with ClinVar data and integrates OpenCravat for detailed annotations from diverse sources.

The application is a reliable resource for [who is this tool for], providing a transparent, score-based system to evaluate the potential deleterious effects of genetic variants, aiding in precise and informed research decisions.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions