Skip to content

Commit

Permalink
Update docs on display and querying.
Browse files Browse the repository at this point in the history
  • Loading branch information
aplf committed Jul 4, 2016
1 parent 90fa296 commit 3c09fe5
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 3 deletions.
34 changes: 33 additions & 1 deletion docs/display_and_visualization.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,36 @@
# Display and visualization

TBD
## Interface features

After running the selected algorithm, you will notice that the program then tries to optimize the display of the group with the largest number of elements in the data set. You can change the speed at which this occurs by moving the animation speed slider.

The Display tab offers the user the ability to search for an isolate, Highlight the SLVs and DLVs, control the animation speed, select diferent diferent or multiple groups. You can fit any displayed graphs to the window by right-clicking any open space (i.e. with no link or ST node) on the window.

Click to see how to use the features:
* [basic interface](http://www.phyloviz.net/wiki/displayinterface/BasicInterface.png),
* [SLV/DLV highlighting](http://www.phyloviz.net/wiki/displayinterface/highlighting.png),
* [ST search](http://www.phyloviz.net/wiki/displayinterface/search.png),
* [information area](http://www.phyloviz.net/wiki/displayinterface/InfoArea.png),
* [force control menu](http://www.phyloviz.net/wiki/displayinterface/ControlMenu.png),
* [high level edges](http://www.phyloviz.net/wiki/displayinterface/HighLevelEdges.png),
* [changing group founder](http://www.phyloviz.net/wiki/displayinterface/ChangingGroupFounder.png),
* [saving results](http://www.phyloviz.net/wiki/displayinterface/SavingResults.png).

## Color conventions

_Link colors for goeBURST results_:
* Black - Link drawn without recourse to tiebreak rules,
* Blue - Link drawn using tiebreak rule 1 (number of SLVs),
* Green - Link drawn using tiebreak rule 2 (number of DLVs),
* Red - Link drawn using tiebreak rule 3 (number of TLVs),
* Yellow - Link drawn using tiebreak rule 4 or 5 (Frequency found on the data set and ST number , respectively),
* Gray - Links drawn at DLV (darker gray) or TLV (lighter gray) if the groups are constructed at DLV/TLV level.

_Link colors for goeBURST Full MST results_: The goeBURST Full MST algorithm links uses a grayscale with darker links having less differences between the profiles than the lighter gray links. To know the number of differences that the link represents click on the link in the Display window.

_ST nodes colors_:
* Light green - Group founder
* Dark green - Sub-group founder
* Light blue - Common node
* Red - Selected node

61 changes: 59 additions & 2 deletions docs/querying_data.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,61 @@
# Querying data
# Querying and visualizing the data

The main goal of PHYLOViZ is to provide a data visualization tool for the users overlay accessory data on the data analysis algorithms result, in order to validate it, or to allow the proposal of new hypothesis. This section will explain the basics on how this can be achieved in our software. To query the data the user has the choice of using regular expressions, or simply manually selecting the desired fields from the table or even just use the checkboxes in the tree view. Using your dataset and this instructions you should be able to create visualizations similar to the ones found in the [PHYLOViZ website](http://www.phyloviz.net/).

## The isolate data tab

The _Isolate Data_ tab is displayed by double clicking on the _Isolate Data_ on the _Dataset_ tree. The following screenshot resumes the basic functionality of the display on the table view.

![Isolate Data tab](http://www.phyloviz.net/wiki/queryvisualization/IsolateDataTable.png)

## The typing data tab

The _Typing Data_ tab contains the allelic profiles loaded in the dataset. The name of displayed on the tab, and on the _Dataset_ tree, is the name of the selected method during the _Load Dataset_ procedure. The user can also query, select and visualize the data of the allelic profiles, similarly to operations describe in the Isolate Data tab.

![Typing Data tab](http://www.phyloviz.net/wiki/queryvisualization/TypingDataTable.png)

## Regular expression primer

Some basic regular expressions that can be used in PHYLOViZ. For more complex expressions there are extensive tutorials on regular expressions online. Just search Regular Expression or regex.

* `.` (period mark) - represents any character.
* `[ ]` (square brackets) - Match anything inside the square brackets for one character position once and only once. Examples: `[40]` will match any field with `4` or `0`; `[7-9]` will match any field will `7`, `8` or `9` ( `-` is the range separator).
* `^`(caret) - Starts with. Ex: `^P` will give you all the fields that start with a `P`. Inside the square brackets means negation. Example `[^a-c]` means anything not `a`, `b` or `c`.
* `$` (dollar sign) - Ends with. Ex. `7$` will give you all fields that end in a `7`.
* `?` (question mark) - Matches the preceding character 0 or 1 times only. Example: `colou?r` will find `color` and `colour`.
* `*` (asterisk) - Matches the preceding character 0 or more times. Example: `tre*` would find `tree`, `tread` and `trough`.
* `+` (plus) - Matches the preceding character 1 or more times. Example: `tre+` would find `tree`, `tread` but not `trough`.
* `{n}` (any integer between brackets) - Matches the preceding character exactly n times. Example: `AT[GC]{2}` would match `ATGC`, `ATCG`, `ATGG` or `ATCC` but not `ATGA`.

All these operators can be combined to create complex search expressions. For example : `^st[G|C].*6$` would find any field that starts with `st` followed by a `C` or a `G` then as 0 or more characters and ends with a `6`. The following screenshot shows the result on the test dataset:

![REGEX example](http://www.phyloviz.net/wiki/queryvisualization/RegexExample.png)

## Queries using the table view

In the _Table_ view of the _Data_ tab you can manually select any field you want to represent by left clicking on it. That will automatically display all the entries with the selected value and not only the selected ones. To select multiple fields you can press the CTRL key (or CMD on Mac) while clicking on the desired fields. If you keep the SHIFT key pressed you can select ranges of cells.

You can also automatically select multiple columns by clicking with the right mouse button on the table headers and pressing the _Select_ button.

Finally to plot the data on the Display tab, press the View button, after all the desired selections are performed.

Click to see an example of querying:
* [_Table_ view with selections](http://www.phyloviz.net/wiki/queryvisualization/TableViewRegex.png),
* [query results Chart](http://www.phyloviz.net/wiki/queryvisualization/TableViewPie.png)
* [results on _Display_ tab](http://www.phyloviz.net/wiki/queryvisualization/TVRdisplay.png)

## Queries using the tree view

The _Tree_ view offers a faster way to create simple queries. The user can also use the regex filter to search the dataset but all the possibilities for each dataset column are automatically indexed in a tree like manner. By pressing the _Select_ button and switching to _Table_ view the user can see the resulting selection. The users can alternate both views (Table and Tree) at will for creating the selection.

![Tree view with selections](http://www.phyloviz.net/wiki/queryvisualization/TreeViewSelections.png)

![Results on Display Tab](http://www.phyloviz.net/wiki/queryvisualization/TreeViewDisplay.png)

## Exporting the results to an image file

To export the resulting graphs to an image file. Click on the _Options_ button and choose _Export_. Select the adequate file format for the intended purpose. We recommend the use of png images for presentation quality and eps for publication quality.

![Export](http://www.phyloviz.net/wiki/queryvisualization/Export.png)

TBD

0 comments on commit 3c09fe5

Please sign in to comment.