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.

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

Improve README #20

Open
5 tasks
sdhutchins opened this issue Dec 16, 2023 · 0 comments
Open
5 tasks

Improve README #20

sdhutchins opened this issue Dec 16, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sdhutchins
Copy link
Member

sdhutchins commented Dec 16, 2023

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.

@sdhutchins sdhutchins added the documentation Improvements or additions to documentation label Dec 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants