search

cBioPortal / GSoC

Documentation repository of Google Summer of Code (GSoC) project ideas for cBioPortal and related projects
108 stars 42 forks source link

"Hint" mode for cBioPortal and OQL editor #74

Closed alisman closed 4 years ago

alisman commented 4 years ago

Background: The portal has a lot of "hidden" features. Features which a large percentage of users don't even know about because they lack prominence in the UI. For example, group comparison, oql qualifiers in gene box.

Goal: To provide hints in the UI when hint mode is turned on. These would appear in prominent parts of the page. We would certainly want to make them dimissable and hideable by mode.

For the gene entry box, we could show a little hint message in proximity to the entry field that would advise users of the existence of modifiers like : MUT etc.

Need skills: React, css, UI design

Possible mentors: Aaron

inodb commented 4 years ago

Looks like there might be some overlap with this one: https://github.com/cBioPortal/GSoC/issues/75?

alisman commented 4 years ago

@inodb @adamabeshouse agreed. i stuck these two together because i wasn't sure the hint mode was "enough" for a full project. What do you think? Is it too menial/basic? As for the OQL hinting, the scope of that project depends on how fancy we make the UI.

inodb commented 4 years ago

@alisman I think just OQL hinting might be enough. We have not gotten that many projects of GSoC to production so might be nice to do some simpler projects. We can always extend during the course of the project. There are a lot of things that need to be learned to really get it to completion I think e.g. adding tests for the hinting, properly writing the description of the PR, proposing a news item

inodb commented 4 years ago

The non oql hint mode part sounds like it might have some similarities with the interactive web tour: #29

inodb commented 4 years ago

I updated the interactive web tour to include this hinting feature: https://github.com/cBioPortal/GSoC/issues/29