MPIIComputationalEpigenetics / DeepBlue-Web

DeepBlue Epigenomic Data Server - Web Interface
http://deepblue.mpi-inf.mpg.de
3 stars 0 forks source link

Idea: put short help info where needed #57

Closed ghost closed 9 years ago

ghost commented 9 years ago

E.g., when a user clicks on Search, display a very brief help info on possible options, like using + for required matches etc. There is enough of white space below the search field to list a few/the most important options

felipealbrecht commented 9 years ago

Please, include a info box (blue one) that contains:

felipealbrecht commented 9 years ago

committed and live. @mpi-pebert please test : http://deepblue.mpi-inf.mpg.de/dashboard.php#ajax/deepblue_view_search.php

ghost commented 9 years ago

Technically what I suggested, though some spelling mistakes and the wording is confusing, e.g., the meaning of document may not be entirely clear for somebody w/o CS background. The last point about the double quotes is unclear: you need to use double quotes to enclose composite terms (like DNA methylation) - and what about the inverse? How do I specify that I do not want "DNA methylation" in any of the matched documents?

Additionally, you may offer similar help snippets at least for the info command, where the intro tour also does not offer any information about what a "DeepBlue ID" actually is - it is not obvious for first time users when to use search and when to use info.

felipealbrecht commented 9 years ago

Please give real examples of what do you expect.

Sent from TypeMail

On Oct 20, 2015, 13:21, at 13:21, Peter Ebert notifications@github.com wrote:

Technically what I suggested, though some spelling mistakes and the wording is confusing, e.g., the meaning of document may not be entirely clear for somebody w/o CS background. The last point about the double quotes is unclear: you need to use double quotes to enclose composite terms (like DNA methylation) - and what about the inverse? How do I specify that I do not want "DNA methylation" in any of the matched documents?

Additionally, you may offer similar help snippets at least for the info command, where the intro tour also does not offer any information about what a "DeepBlue ID" actually is - it is not obvious for first time users when to use search and when to use info.


Reply to this email directly or view it on GitHub: https://github.com/MPIIComputationalEpigenetics/DeepBlue-Web/issues/57#issuecomment-149531657

ghost commented 9 years ago

Change wording, e.g., as follows: 1) Use +keyword for keywords that must be in the search results 2) Use -keyword for keywords that must not be in the search results 3) Use " " (double quotes) to enclose composite keywords, e.g., "DNA methylation"

Example: The search "DNA methylation" +grch38 -wgbs will look for all data in DeepBlue that match "DNA methylation" and "grch38", but not "wgbs".

Expected behavior: The search -"DNA methylation" +grch38 will look for all data in DeepBlue that match grch38, but not DNA methylation

Is that possible?

To the second point from above, add something like: Each data item in DeepBlue has an internal ID, e.g., the ID eXXXXXX refers to the experiment . If you want to look up all information linked to a DeepBlue ID, enter the ID in the above field and hit the search button*

Why is it a search button (the magnifying glass)? Shouldn't it rather be the "i" again for info?

felipealbrecht commented 9 years ago

Okay, I will do it, but I will keep the negation with quotes out because if it does work.

-"DNA methylation"

Peter Ebert wrote:

Change wording, e.g., as follows: 1) Use /+keyword/ for keywords that must be in the search results 2) Use /-keyword/ for keywords that must not be in the search results 3) Use " " (double quotes) to enclose composite keywords, e.g., "DNA methylation"

Example: The search "DNA methylation" +grch38 -wgbs will look for all data in DeepBlue that match "DNA methylation" and "grch38", but not "wgbs".

Expected behavior: The search -"DNA methylation" +grch38 will look for all data in DeepBlue that match grch38, but not DNA methylation

Is that possible?

To the second point from above, add something like: Each data item in DeepBlue has an internal ID, e.g., the ID eXXXXXX refers to the experiment . If you want to look up all information linked to a DeepBlue ID, enter the ID in the above field and hit the search button*

Why is it a search button (the magnifying glass)? Shouldn't it rather be the "i" again for info?

— Reply to this email directly or view it on GitHub https://github.com/MPIIComputationalEpigenetics/DeepBlue-Web/issues/57#issuecomment-149560406.

felipealbrecht commented 9 years ago

@mpi-pebert look.