Difference between revisions of "The GenGIS 2.5 Manual"

From The GenGIS wiki
Jump to navigationJump to search
 
(31 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
Welcome to the GenGIS 2.1 manual.  The sections below provide enough information to configure and start using GenGIS.  Stay tuned for updates and send us [mailto:beiko@cs.dal.ca?Subject=GenGIS%20feedback your feedback] when you get an opportunity.
+
Welcome to the GenGIS 2.5 manual.  The sections below provide enough information to configure and start using GenGIS.  Stay tuned for updates and send us [mailto:beiko@cs.dal.ca?Subject=GenGIS%20feedback your feedback] when you get an opportunity.
  
  
Line 22: Line 22:
 
=== Citing GenGIS ===
 
=== Citing GenGIS ===
  
−
The best citation for GenGIS is indicated in boldface on the [http://kiwi.cs.dal.ca/~beiko/mediawiki/mediawiki-1.13.4/index.php Main GenGIS page].
+
The best citation for GenGIS is indicated in boldface on the [http://kiwi.cs.dal.ca/GenGIS/Main_Page Main GenGIS page].
  
 
=== Where to go for Help ===
 
=== Where to go for Help ===
Line 88: Line 88:
 
# Go to the '''C:\Program Files\R\R-2.xx.x\bin\i386''' directory.
 
# Go to the '''C:\Program Files\R\R-2.xx.x\bin\i386''' directory.
 
# Copy all the files ending in '''.dll''' to the '''C:\Program Files\R\R-2.xx.x\bin\''' directory.
 
# Copy all the files ending in '''.dll''' to the '''C:\Program Files\R\R-2.xx.x\bin\''' directory.
 +
# Right Click '''Computer''' --> '''Properties''' --> '''Advanced system settings''' --> '''Environment Variables'''.
 +
# Create a new environment variable '''R_HOME''' which points to R's root directory, eg. '''C:\Program Files\R\R-2.xx.x\'''.
 +
# Create a new environment variable '''R_USER''' which points to your documents, eg. '''C:\Users\xx\Documents\'''.
  
 
|}
 
|}
Line 179: Line 182:
  
 
GenGIS currently does not support projections in which a single point is displayed in multiple locations.  The best example of this is the default world map, which is modified to stretch from 89.9 degrees North to 89.9 degrees South latitude.  Since the poles stretch across the entire upper and lower edges of a map in a projection such as Plate Carre, GenGIS is unable to display these properly.
 
GenGIS currently does not support projections in which a single point is displayed in multiple locations.  The best example of this is the default world map, which is modified to stretch from 89.9 degrees North to 89.9 degrees South latitude.  Since the poles stretch across the entire upper and lower edges of a map in a projection such as Plate Carre, GenGIS is unable to display these properly.
 +
 +
'''Warning''': Currently the projections are not working properly. You might get errors in some cases.
  
 
==== Typical limits on map size ====
 
==== Typical limits on map size ====
Line 267: Line 272:
 
|- valign="top"
 
|- valign="top"
 
| colspan="2" |
 
| colspan="2" |
−
[[Image:v200_GUI_Overview_Mashup_labels.png|frameless|720px|center|Overview of GenGIS graphical user interface.]]
+
[[Image:v210_GUI_Overview_Mashup_labels.png|frameless|720px|center|Overview of GenGIS graphical user interface.]]
  
 
|- valign="top"
 
|- valign="top"
Line 318: Line 323:
 
* '''Add Sequence Data:''' Add sequence data to the currently selected location set.
 
* '''Add Sequence Data:''' Add sequence data to the currently selected location set.
 
* '''Add Tree:''' Add a geographic tree model to the currently selected map.
 
* '''Add Tree:''' Add a geographic tree model to the currently selected map.
 +
* '''Merge Layer:''' Merge one or more layers into a new layer placed at the top of the stack.
 
* '''Remove Layer:''' Remove the currently selected layer.
 
* '''Remove Layer:''' Remove the currently selected layer.
 
* '''Remove All Layers:''' Remove all layers.
 
* '''Remove All Layers:''' Remove all layers.
Line 357: Line 363:
 
| [[Image:v200_icon_DEM.png]] || '''Add raster map''' || Add a raster map to the currently selected study.
 
| [[Image:v200_icon_DEM.png]] || '''Add raster map''' || Add a raster map to the currently selected study.
 
|-
 
|-
−
| [[Image:v200_icon_DEM.png]] || '''Add vector map''' || Add a vector map to the currently selected study.
+
| [[Image:v200_icon_SHP.png]] || '''Add vector map''' || Add a vector map to the currently selected study.
 
|-
 
|-
 
| [[Image:v200_icon_location.png]] || '''Add location set''' || Add a location set to the currently selected map.
 
| [[Image:v200_icon_location.png]] || '''Add location set''' || Add a location set to the currently selected map.
Line 502: Line 508:
 
|}
 
|}
  
−
=== Map Layer Properties ===
+
=== Raster Map Layer Properties ===
  
−
The Map Layer displays a map file and directly interacts with other layers (e.g., location, sequence, tree).  The Map Layer properties dialog controls settings such as map layer metadata (e.g., name, description), colour scheme and rendering detail.  Metadata from the map file (e.g., dimensions, origin) is also displayed.  At this time, GenGIS supports a single map layer per session.  Components of the Map Layer properties dialog are explained in greater detail below.
+
The Raster Map Layer displays a raster map file and directly interacts with other layers (e.g., location, sequence, tree).  The Map Layer properties dialog controls settings such as map layer metadata (e.g., name, description), colour scheme and rendering detail.  Metadata from the map file (e.g., dimensions, origin) is also displayed.  At this time, GenGIS supports a single map layer per session.  Components of the Map Layer properties dialog are explained in greater detail below.
  
 
{| cellpadding="10%" cellspacing="0" style="border:1px solid #BBB"
 
{| cellpadding="10%" cellspacing="0" style="border:1px solid #BBB"
Line 512: Line 518:
 
     |+ General Tab
 
     |+ General Tab
 
     |-
 
     |-
−
     | [[Image:V200_MapProperties_General.png | frameless | 380px | center ]]
+
     | [[Image:mapLayer1.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     | The General tab contains three editable layer metadata fields: ''Layer name'', ''Description'', and ''Authors''.  Changing the layer name also changes the name of the layer within the [[The_GenGIS_Manual#Layer_Tree_Controller|Layer Tree Controller]].
 
     | The General tab contains three editable layer metadata fields: ''Layer name'', ''Description'', and ''Authors''.  Changing the layer name also changes the name of the layer within the [[The_GenGIS_Manual#Layer_Tree_Controller|Layer Tree Controller]].
Line 520: Line 526:
 
     |+ Symbology > '''Colour Map''' Tab
 
     |+ Symbology > '''Colour Map''' Tab
 
     |-
 
     |-
−
     | [[Image:V200_MapProperties_Symbology_ColourMap.png | frameless | 380px | center ]]
+
     | [[Image:mapLayer2.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     | The Colour Map tab provides controls to change the map colour scheme, where distinct colours represent differences in terrain elevation.
 
     | The Colour Map tab provides controls to change the map colour scheme, where distinct colours represent differences in terrain elevation.
Line 534: Line 540:
 
     |+ Symbology > '''Advanced''' Tab
 
     |+ Symbology > '''Advanced''' Tab
 
     |-
 
     |-
−
     | [[Image:V200_MapProperties_Symbology_Advanced.png | frameless | 380px | center ]]
+
     | [[Image:mapLayer22.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     |
 
     |
Line 544: Line 550:
 
     |+ Metadata Tab
 
     |+ Metadata Tab
 
     |-
 
     |-
−
     | [[Image:V200_MapProperties_Metadata.png | frameless | 380px | center ]]
+
     | [[Image:mapLayer4.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     |
 
     |
 
* Metadata from the map file (e.g., dimensions, origin) are visible within the Metadata tab.
 
* Metadata from the map file (e.g., dimensions, origin) are visible within the Metadata tab.
 +
    |}
 +
|- valign="top"
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ Cartogram Tab
 +
    |-
 +
    | [[Image:mapLayer3.png | frameless | 380px | center ]]
 +
    |-
 +
    |
 +
* Create a cartogram based on one or all of the location layers.
 +
* Vector layers can also be distorted with the map.
 +
* ''Location Radius'' prescribes the area each location's value covers.
 +
* ''Variable Multiplier'' increases the magnitude of each locations value.
 +
* ''Resize Density Matrix'' reduces the resolution of the map for cartogram creation. This reduces resource requirements and improves runtime, but introduces inaccuracies into the finalized map.
 
     |}
 
     |}
 
|}
 
|}
  
 +
==== Creating a Cartogram ====
 +
 +
Cartograms are geographic visualization techniques which transfer the distribution of land area in a map from distance to another parameter of interest (such as population). This display technique has been integrated into ''GenGIS'' based on the diffusion-based cartogram. To create a cartogram a map and location layer are required. Additional location and vector layers can be transformed with the raster layer. To create a cartogram the ''Location Radius'' and ''Variable Multiplier'' must be set to some level. ''Location Radius'' defines the level of geographic preservation at a regional scale, while ''Variable Multiplier'' applies more distortion locally.
 +
 +
[[Image:cartogram.png | 720px | center ]]
  
 
=== Vector Map Layer Properties ===
 
=== Vector Map Layer Properties ===
Line 570: Line 595:
 
     |+ Symbology > '''Point''' Tab
 
     |+ Symbology > '''Point''' Tab
 
     |-
 
     |-
−
     | [[Image:V200_MapProperties_Symbology_ColourMap.png | frameless | 380px | center ]]
+
     | [[Image:V200_VectorMapProperties_Symbology_Point.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     | The Point tab provides controls to change the size, shape, border colour, filling colour, and border size of  point features.
 
     | The Point tab provides controls to change the size, shape, border colour, filling colour, and border size of  point features.
Line 579: Line 604:
 
     |+ Symbology > '''Polyline''' Tab
 
     |+ Symbology > '''Polyline''' Tab
 
     |-
 
     |-
−
     | [[V200_VectorMapProperties_Symbology_Polyline.png | frameless | 380px | center ]]
+
     | [[Image:V200_VectorMapProperties_Symbology_Polyline.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     |The Polyline tab provides controls to change the line style, colour, thickness, border size, and border colour of line features.
 
     |The Polyline tab provides controls to change the line style, colour, thickness, border size, and border colour of line features.
Line 587: Line 612:
 
     |+ Symbology > '''Polygon''' Tab
 
     |+ Symbology > '''Polygon''' Tab
 
     |-
 
     |-
−
     | [[ | frameless | 380px | center ]]
+
     | [[Image:V200_VectorMapProperties_Symbology_Polygon.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     |The Polygon tab provides controls to change the style, thickness, and colour for the border line of polygon features.
 
     |The Polygon tab provides controls to change the style, thickness, and colour for the border line of polygon features.
Line 597: Line 622:
 
     |+ Metadata Tab
 
     |+ Metadata Tab
 
     |-
 
     |-
−
     | [[Image:V200_MapProperties_Symbology_Advanced.png | frameless | 380px | center ]]
+
     | [[Image:V200_VectorMapProperties_Metadata.png | frameless | 380px | center ]]
 
     |-
 
     |-
 
     |Metadata from the shapefile (e.g., projection, features type) are visible within the Metadata tab.  
 
     |Metadata from the shapefile (e.g., projection, features type) are visible within the Metadata tab.  
Line 702: Line 727:
  
 
|- valign="top"
 
|- valign="top"
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ Grid > '''Colour''' Tab
 +
    |-
 +
    | [[Image:griddingColour.png | frameless | 380px | center ]]
 +
    |-
 +
    |
 +
The colour tab provides controls to modify tile colour.
 +
* All tiles can be displayed in a uniform colour by selecting the ''Uniform colour'' radio-button.
 +
* Alternatively, each tile can be assigned a unique colour based on a property(e.g., Cell ID). This is performed by selecting the ''Colour Map'' radio button and selecting appropriate ''Field to chart'' and ''Colour map'' fields.
 +
* Tiles that do not contain values will be given a default colour. This can be changed with the ''Default Colour'' colour picker. The opacity of theses default tiles can be changed with the ''Default Opacity'' slider.
 +
* Individual colours for locations can be adjusted in the nested window containing rows of colour buttons.
 +
* Controls to modify location border colour, width, opacity and style are also provided.
 +
    |}
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ Grid > '''Custom''' Tab
 +
    |-
 +
    | [[Image:griddingCustom.png | frameless | 380px | center ]]
 +
    |-
 +
    |
 +
The custom tab provides controls to modify the size, alignment, elevation and combination method of tiles.
 +
* The Map can be divided by size or divisions based on Tile Size radios. Division orientation and division granularity can be selected here.
 +
* Grids can be aligned here to the maps origin, any active location, or coordinates on the map.
 +
* Map elevation can be controlled manually with the ''Auto adjust to map elevation'' check box.
 +
* ''Tile Fields'' changes how different metadata are combined in tiles.
 +
    |}
 +
|- valign="top"
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ Polygon Tab
 +
    |-
 +
    | [[Image:LocationSetProperties_Polygons.PNG | frameless | 380px | center]]
 +
    |-
 +
    |
 +
The polygon tab provides controls to visualize location data as polygons.
 +
* Polygons can be activated by checking the ''Draw Polygons'' checkbox, which will draw a polygon using all active locations.
 +
* The method being used to draw the polygons, along with its description, is determined by the chosen ''Algorithm''.
 +
* General properties of the polygon include its opacity, whether its edges are straight or curved, and its elevation.
 +
* If the polygon is not auto adjusted to the map elevation, then a custom elevation can be specified in the box labeled ''Vertical Elevation''.
 +
* In addition, if the ''Increasing Elevation'' checkbox is checked, then each polygon will be drawn at an increasing height above the map. The change in height between each polygon is determined by the value in the box labeled ''Elevation Offset''.
 +
* Polygon sizing options include inflation and scaling. ''Polygon inflation'' will expand the polygon outward by a constant amount from each vertex while ''polygon scaling'' will expand the polygon outward using the scaling factor in the text box.
 +
* Borders of the polygons will be drawn if the ''Show Borders'' checkbox is checked. Controls to modify these borders include opacity and thickness.
 +
    |}
 
|
 
|
 
     {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 
     {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
Line 720: Line 789:
 
     |}
 
     |}
 
|}
 
|}
 +
  
 
=== Location Layer Properties ===
 
=== Location Layer Properties ===
Line 925: Line 995:
  
 
The geographic axis being evaluated can be modified dynamically. To modify the geographic axis, simple click on either of the end-points of the Layout Line and drag it to a new location. The vertices defining a non-linear geographic axes can also be modified dynamically. Making the Layout Line shorter will reduce the size of the 2D tree. The height of the tree can also be modified in the [[The_GenGIS_2.0_Manual#Tree_Layer Properties|Tree Layer Properties]] dialog. You can also drag the root node of a tree to re-position the tree while keeping the Layout Line at the same orientation.
 
The geographic axis being evaluated can be modified dynamically. To modify the geographic axis, simple click on either of the end-points of the Layout Line and drag it to a new location. The vertices defining a non-linear geographic axes can also be modified dynamically. Making the Layout Line shorter will reduce the size of the 2D tree. The height of the tree can also be modified in the [[The_GenGIS_2.0_Manual#Tree_Layer Properties|Tree Layer Properties]] dialog. You can also drag the root node of a tree to re-position the tree while keeping the Layout Line at the same orientation.
 +
 +
==== Zoom into a Sub-tree ====
 +
 +
Displays the sub-tree defined by the selected node.
 +
{| cellpadding="10%" cellspacing="0" style="border:1px solid #BBB"
 +
 +
|- valign="top"
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ '''Original tree:'''
 +
    | [[Image:zoom1.png | frameless | 380px | center ]]
 +
    |}
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ '''Zoomed in:'''
 +
    | [[Image:zoom2.png | frameless | 380px | center ]]
 +
    |}
 +
|}
 +
==== Collapse a Sub-tree ====
 +
 +
Displays the sub-tree defined by the selected node as a wedge, coloured by the proportional content of all child leaf nodes.
 +
{| cellpadding="10%" cellspacing="0" style="border:1px solid #BBB"
 +
 +
|- valign="top"
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ '''Original tree:'''
 +
    | [[Image:collapse1.png | frameless | 380px | center ]]
 +
    |}
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ '''Tree with collapsed nodes:'''
 +
    | [[Image:collapse2.png | frameless | 380px | center ]]
 +
    |}
 +
|}
 +
 +
==== Split a Sub-tree ====
 +
 +
Removes a sub-tree defined by the highest selected node from the original tree. This node becomes the root node in a new separated tree.
 +
{| cellpadding="10%" cellspacing="0" style="border:1px solid #BBB"
 +
 +
|- valign="top"
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ '''Original tree:'''
 +
    | [[Image:split1.png | frameless | 380px | center ]]
 +
    |}
 +
|
 +
    {| cellpadding=5 style="margin: 1em auto 1em auto; width:400px;"
 +
    |+ '''Resulting trees:'''
 +
    | [[Image:split2.png | frameless | 380px | center ]]
 +
    |}
 +
|}
  
 
==== Visual Properties ====
 
==== Visual Properties ====

Latest revision as of 20:49, 15 May 2016

Welcome to the GenGIS 2.5 manual. The sections below provide enough information to configure and start using GenGIS. Stay tuned for updates and send us your feedback when you get an opportunity.


Contents

Introduction / Overview of GenGIS

Purpose

Geography has always been an important component of evolutionary and ecological theory. The advent of sequence typing approaches such as 16S ribotyping, DNA barcoding using the COX1 gene, and multi-locus sequence typing, gives us the opportunity to understand how communities of organisms interact, disperse and evolve. This sequencing revolution is tightly coupled to the development of new algorithms for assessing and comparing populations based on their genes.

Coupled with these developments is the availability of high quality, public domain digital map data. By integrating molecular data with cartography and habitat parameters, we can visualize the geographic and ecological factors that influence community composition and function.

GenGIS is designed to bring these components together into a single software package that satisfies the following criteria:

Free and Open Source
GenGIS is released under a Creative Commons Attribution - Share Alike 3.0 license, and we have made extensive use of other free packages such as wxWidgets, R, and Python. Making GenGIS freely available allows it to be downloaded and used anywhere in the world, and allows users to inspect and modify the source code.
User-Friendly Interface
Although GenGIS is built to deal with challenging scientific questions, our goal is to make the software easy to use. This is particularly important as many users will have little experience with digital map data, apart from applications such as Google Earth.
Adaptible and Extensible
The principal strength of many open-source projects lies in the ability of a loosely organized community of users to develop and enhance the software: R and BioPerl are two examples of successful open-source projects with many contributors. Since the potential applications of GenGIS are much broader than those we have in mind, we aim to make it as easy as possible to extend its capabilities by exposing the internal data structures and offering a plugin architecture.

Citing GenGIS

The best citation for GenGIS is indicated in boldface on the Main GenGIS page.

Where to go for Help

  • Text and video tutorials are available on the Tutorials page.
  • The FAQ page keeps track of GenGIS-related questions.
  • Please email with any questions or feedback about the software.

Installation

Getting the Latest Version of GenGIS

Download the latest version for Windows or Mac to get started visualizing and analyzing data in GenGIS.

System Requirements

GenGIS has been developed and tested on the following operating systems:

Developer Version – building from source code

The source code for GenGIS is available on the Download page.

Building on Windows GenGIS can be compiled using Microsoft Visual C++ 2008 Express Edition. The Visual Studio solution file (GenGIS.sln) is located in the 'win32/build/msvc' directory. Please note that the built-in Python console is only available in Release builds.
Building on MacOSX GenGIS can be compiled using the Makefile located in the 'mac/build/gcc' directory. To compile, simply run 'make' within a terminal. Development has been performed using the gcc 4.3.3 compiler.

R and GenGIS

GenGIS integrates with the R programming language to provide additional statistics and visualization tools. Calls to the R environment are made by certain GenGIS plugins (e.g., Mantel).

To configure R with GenGIS:

Manually Configuring R (Windows)

Note: the R Auto-Configuration Utility performs these configurations automatically.

Recent versions of R (e.g., v2.14.1) use a different installation file structure that is incompatible with the Windows version of GenGIS. The issue can be resolved by means of a harmless workaround described below. If running GenGIS on MacOSX, you may skip this section. For Windows XP users, the path to the R bin directory (e.g., C:\Program Files\R\R-2.14.1\bin) needs to be set within the Windows PATH environment variable.

Manually Transferring DLLs:

Windows XP, Vista & 7
  1. Close GenGIS.
  2. Go to the C:\Program Files\R\R-2.xx.x\bin\i386 directory.
  3. Copy all the files ending in .dll to the C:\Program Files\R\R-2.xx.x\bin\ directory.
  4. Right Click Computer --> Properties --> Advanced system settings --> Environment Variables.
  5. Create a new environment variable R_HOME which points to R's root directory, eg. C:\Program Files\R\R-2.xx.x\.
  6. Create a new environment variable R_USER which points to your documents, eg. C:\Users\xx\Documents\.

Manually Setting the PATH Variable:

Windows XP Only
  1. Close GenGIS
  2. Go to the C:\Program Files\R\ directory (install R if this directory is missing).
  3. Open the folder corresponding to the latest version of R (e.g., 'R-2.14.1').
  4. Open the bin directory.
  5. Copy the entire directory path from the folder window (e.g., 'C:\Program Files\R\R-2.14.1\bin'). This information is what you will add to the Path variable.
  6. Follow the instructions on this page.

R Auto-Configuration Utility

The R Auto-Configuration Utility configures R to work with GenGIS and is located in the Settings menu.

  • For recent versions of R (e.g., 2.14.1), a GenGIS dialog will appear prompting to select the latest version of R being used on the system:

V200 SelectRVersionDialog.png


  • After the selection, a confirmation window will appear:

V200 RConfigurationRequiredDialog.png


  • On Windows Vista/7, you will need to provide the Windows User Account Control (UAC) permission to complete the configuration:

V200 DestinationFolderAccessDenied.png

  • On Windows Vista/7, R should now work without requiring a restart of GenGIS.
  • Windows XP users will be prompted to add the R installation directory to the Windows Path variable. After completing this step a reboot of Windows is required for the changes to take effect.

Input data

Data File Types

GenGIS works with four different types of data files:

  1. Digital Map File(s) (sample)
  2. Location File (sample)
  3. Sequence File (sample)
  4. Tree File (sample)

Data files should be loaded in the following orders: 

 Map(s) → Location → Sequence → Tree

or 

 Map(s) → Location → Tree

Version 2.1 and above: GenGIS now supports vector data, with or without an underlying raster. If a raster file is to be used, it should be loaded before any vector data. If no raster is provided, the first vector file loaded will be used to initialize the map environment, and will be listed first. The minimap boundaries and default views will be based on the dimensions of this vector, even if other vector files are added and the original vector subsequently deleted. Any number of vector files can be loaded and viewed in GenGIS; these can be added and deleted at any stage.


GenGIS currently supports a single location and sequence file during a session. Any number of tree files can be opened.


Note: The location of sequences (sequence file) and leaves (tree file) must each map to an existing location given by the location file. The leaves of a tree file can be identifiers for either locations or sequences.

Maps

GenGIS relies on the Geospatial Data Abstraction Library (GDAL) to import several digital map file formats and projections. More information, including community support and downloads, can be found at the GDAL website.

Note: The 'gdal_merge.py' script, 'gdalwarp.exe' and 'gdal_translate.exe' executables have been very useful in preparing maps compatible with GenGIS.

Supported raster formats

GenGIS supports the formats listed on the GDAL Raster Formats page. Note that not all formats have been tested at this time. The following formats have been found to work reliably:

  • GeoTIFF
  • Arc/Info ASCIIGRID
  • USGS DEM (and variations thereof)

Supported vector formats

We have tested GenGIS on a number of different ESRI shape files (typically ending in .shp).

Projections

If you wish to use a specific projection, you must specify it before loading your map - GenGIS is unable to render reprojections on the fly. This is particularly true if you are loading the default world map (from GTOPO30) that ships with GenGIS: the default Mercator projection stretches the polar regions, whereas Plate Carre or Robinson will provide a much less distorted world view.

To specify the projection before loading the map, right click "New Study : Study" in the Layers tab, and select Properties. Selecting the Projection tab will allow you to choose your projection.

GenGIS currently does not support projections in which a single point is displayed in multiple locations. The best example of this is the default world map, which is modified to stretch from 89.9 degrees North to 89.9 degrees South latitude. Since the poles stretch across the entire upper and lower edges of a map in a projection such as Plate Carre, GenGIS is unable to display these properly.

Warning: Currently the projections are not working properly. You might get errors in some cases.

Typical limits on map size

Higher processor speeds and more system RAM are required to work effectively with larger maps. Typically one gigabyte of RAM permits working with maps that are 10 megabytes or slightly greater in size.

Reducing Map Size

If the map resolution of is too high for the system hardware being used, the GDAL Utilities 'gdalwarp' or 'gdal_translate' can be used to reduce the density of points in the map. Decreasing the level of detail is an acceptable tradeoff in many cases.

Location File

The location file must be provided in either tab-delimited or comma-separated formats (e.g., the .CSV files that can be exported from Microsoft Excel). The first line of the file must be a series of headers. Each subsequent line should contain a set of attributes for a single location.

  • The first entry of the header must be a unique location identifier with the label Site ID or Sample ID.
  • A vertical coordinate labelled as Latitude (decimal degrees) or Northing (Universal Transverse Mercator, UTM) must be included but can be present at any column position after the unique location identifier. Note that positive values = north and negative values = south.
  • A horizontal coordinate, labelled as Longitude (decimal degrees) or Easting (Universal Transverse Mercator, UTM) must be included but can be present at any column position after the unique location identifier. Note that Positive values = east and negative values = west.

The first line of the file may look something like the following: 

Site ID, Latitude, Longitude

or 

Site ID, Northing, Easting

depending on the coordinate system.

GenGIS provides the ability to specify many different custom column headers within the Location file, including longer descriptive site names, environmental parameters, or a time stamp. For instance, a location file header might look like this: 

Site ID, Latitude, Longitude, File Size, Environment Type, Geographic Location, Site Name, Country

Each of these values must then be specified for every entity (= row in the file), even if they are called NULL or some other placeholder value.

Sequence File

The basic specification of the sequence file is even simpler, with only two required fields:

  • A unique location identifier that is also found in the location file
  • A unique sequence identifier

The first line of the file must begin with the following column headings: 

Site ID, Sequence ID

Columns containing custom information can be added after the two mandatory headings. Each row of the sequence file must define a value for each of the columns identified in the header line. Note that the 'sequence file' need not contain any molecular sequence data, nor do the entities necessarily need to have a one-to-one correspondence to actual sampled sequences.

A simple sequence file might summarize the taxonomic classification of each sampled sequence: 

Site ID, Sequence ID, Best_match, Species, Genus, Family, Order, Class, Phylum, Superkingdom

Multiple identical sequences at a location

A count field may be specified within a Sequence File to indicate the number of times a given sequence is present at a given site. This has the benefit of significantly reducing the size of a Sequence File. 

 Site Id, Sequence Id, Count, Domain, Phylum, Class, Order, Family, Genus, Species

The count field can be assigned any name within the Sequence File. Multiple count fields may be specified indicating different quantitative aspects of a named sequence type such as number of sequences or total base pairs observed. The count field can then be specified in various locations within GenGIS. For example, quantitative pie charts reflecting the number of times each sequence type is observed at a location can be created through the Location Set Properties dialog:

  1. Open the Location Set Properties dialog
  2. Navigate to the Charts > Colour Map tab
  3. Select "Create quantitative charts using count data in field"
  4. Select the desired count field from the adjacent drop down menu


V200 LocationSetProperties Charts ColourMap SettingCountField.png

Tree File

Input trees should adhere to the Newick file format, with the additional constraint that leaf labels must match up exactly with either a Site ID from the location file or a Sequence ID from the sequence file.

The Environment

Overview

  • The graphical user interface for GenGIS consists of a collection of different interface elements. Many features of GenGIS can be accessed through the Menu.
  • The most commonly used features are exposed on the Toolbar.
  • Data loaded into GenGIS is organized into a Layer Tree, which is made explicit to the user in the panel on the left. This hierarchical structure provides a natural organization of data and allows the properties of related data items to be set easily.
  • Data visualizations are displayed in the 3D Viewport. Mouse navigation within this 3D environment follows a standard world-in-hand navigation model.
  • Alternatively, the camera position and angle can be modified using the Navigation Widget, which also provides an overview map.
Overview of GenGIS graphical user interface.
  • The Console provides feedback to the user such as the results of statistical tests and warnings about potential problems with loaded data.
  • Almost all features available through the graphical user interface can be accessed within the Python Console window. This includes loading data layers, modifying camera parameters, and accessing location or sequence data.
  • Information about interface elements or graphical features within the Viewport is displayed on the Statusbar.

Menu Items

File Menu
  • New Session: Start a new instance of GenGIS.
  • Open Session: Open a saved GenGIS session.
  • Recent Sessions: Displays a menu of recent sessions.
  • Save: Save session to file.
  • Save As...: Specify a new filename and save session to file.
  • Export as Image...: Save Viewport contents to a PNG image file.
  • Exit: Exits the program.
View Menu
  • Panes → Side Panel: Hide/unhide the left side panel containing the Layer tree.
  • Panes → Console: Hide/unhide the bottom panel containing the Console and Python Console.
  • Map Controls → Navigation Control: Show/Hide the zoom and navigation buttons on the Navigation widget.
  • Map Controls → Overview Map: Show/Hide mini-map display on the navigation widget.
  • Map Controls → Compass: Show/Hide the compass on the navigation widget.
  • Map Controls → Show all: Show all controls of the navigation widget.
  • Map Controls → Hide all: Show/Hide the compass on the navigation widget.
  • Camera Position → Default: Move camera to its default perspective position.
  • Camera Position → Top: Move camera to give a top-down view of the map.
  • Show Text Under Toolbar Icons: Enable/Disable textual labels under the main toolbar icons.
Layer Menu
  • Add Raster Map: Add a raster map to the currently selected study.
  • Add Vector Map: Add a vector map to the currently selected study.
  • Add Location Set: Add a location set to the currently selected map.
  • Add Sequence Data: Add sequence data to the currently selected location set.
  • Add Tree: Add a geographic tree model to the currently selected map.
  • Merge Layer: Merge one or more layers into a new layer placed at the top of the stack.
  • Remove Layer: Remove the currently selected layer.
  • Remove All Layers: Remove all layers.
  • Hide All Layers: Hide all layers so they are no longer displayed in the Viewport.
  • Show All Layers: Show all layers in the Viewport.
Settings Menu
  • Label Font Settings: Brings up the Font Properties dialog box to change font settings of labels.
  • Lighting Settings: Brings up the Lighting Properties dialog box which allows properties of the light source used to render the Viewport to be modified.
  • Layout Object Settings: Brings up the Layout Objects Properties dialog box which all visual properties of layout primitives to be modified.
  • Show Welcome Screen on Startup: Show a welcome screen with list of common operations during startup.
Analysis Menu
  • Select Sequence Dialog: Select a subset of sequences from a sequence file.
Plugins Menu
Help Menu
  • GenGIS Manual: Displays the GenGIS Manual in a web browser.
  • About: Brings up an About GenGIS dialog box which contains a link to this website and other information.

Toolbar Buttons

The main toolbar provides easy access to frequently used features.

V200 icon fileopensession.png Open Session Open a file to restore a previous GenGIS session.
V200 icon DEM.png Add raster map Add a raster map to the currently selected study.
V200 icon SHP.png Add vector map Add a vector map to the currently selected study.
V200 icon location.png Add location set Add a location set to the currently selected map.
V200 icon sampledata.png Add sequence data Add sequence data to the currently selected location set.
V200 icon phylogram.png Add tree Add a geographic tree model to the currently selected map.
V200 icon reset.png Default perspective view Move camera to its default perspective position.
V200 icon top.png Top view Move camera to give a top-down view of the map.
V200 icon line.png Draw layout line Draw a straight line which can be used to layout graphic elements such as a 2D tree or pie charts.
V200 icon ellipse.png Draw layout ellipse Draw an ellipse which can be used to layout graphic elements such as a 2D tree or pie charts.
V200 icon polyline.png Draw geographic axis Draw a polyline which can be used to test the goodness-of-fit between a tree and a non-linear geographic axes (see 2D Pylogenetic Trees).

Note: GenGIS does not support loading multiple maps, location sets or sequence sets. Adding multiple trees is experimental at this time.

Navigating the Viewport

GenGIS offers three different options to navigate maps: direct mouse gestures, a navigation widget, and two predefined views.

Mouse
  • The map can be moved by dragging with the left mouse button.
  • Camera pitch is controlled by dragging with the right mouse button in vertical directions.
  • Map rotation is performed by dragging with the left mouse button in horizontal directions.
  • Camera zoom level is controlled using the mouse scroll wheel.
Navigation Widget NavigationWidget.jpg
  • The navigation widget is located within the top right region of the viewport and provides additional controls to navigate the map.
  • The arrows at the top of the widget move the map transversely while the 'plus' and 'minus' buttons control camera zoom.
  • Clicking within the overview map (mini map) repositions the main map such that the area clicked is centred on the viewport.
  • Clicking or dragging the compass face rotates the map.
Predefined Views CameraViewToolbar.jpg
  • GenGIS also provides predefined Perspective and Top views.
  • To quickly switch to a perspective view or a top down view use either the corresponding toolbar buttons (left) or the menu options located in the View → Camera Position.

Layer Tree Controller

The Layer Tree Controller (Windows)
  • The Layer Tree Controller is located in a left panel within GenGIS and provides a hierarchical view of the Study, Map, Location Set, Location, Sequence and Tree layers.
  • Double clicking on the title of any layer within the controller (or right-clicking the same region and selecting Properties from a pop-up menu) opens a corresponding properties dialog for that layer.
  • Layers can be enabled (shown) and disabled (hidden) by clicking on corresponding 'x' control boxes within the controller.

Location Legend

The Location Legend (Windows)
  • The Location Legend is located in a left panel within GenGIS and provides an overview of colour, shape and size selections for locations.
  • Left clicking on a colour, shape or size opens a properties dialog to modify that particular field.

Sequence Legend

The Sequence Legend (Windows)
  • The Sequence Legend is located in a left panel within GenGIS and provides an overview of different available sequence fields.
  • A sequence colour can be modified by clicking on its colour button within the Sequence Legend panel.

Console Panels

GenGIS features an output console and a Python console both located at the bottom of the main interface.

Output Console

The Output Console displays a log of successful program operations (e.g., loading data files such as map files) as well as possible errors.

The GenGIS console.

Python Console

The Python console contains a fully-functional Python interpreter that provides access to data structures within GenGIS (e.g., location layer data) and API functions (e.g., the ability to automate camera and lighting controls via Python scripting). The Python console is described in greater detail later in the manual.

The GenGIS Python console.

Interacting with sample sites

Layer Property Dialogs

Study Layer Properties

The Study Layer is automatically created during a new session. The Study Properties dialog provides controls to change settings such as study layer metadata (name, description and authors), background colour and terrain resolution. Components of the Study Layer properties dialog are explained in greater detail below.

General Tab
V200 StudyProperties General.png
  • The General tab contains three editable layer metadata fields: Layer name, Description, and Authors.
  • Editing the study Layer name property also updates its corresponding representation within the Layer Tree Controller.
Projection Tab
V200 StudyProperties Projection.png
  • The Datum and Projection fields can be set from within the Projection tab.
    Note: The projection must be set before loading a map.
Symbology Tab
V200 StudyProperties Symbology.png
  • The Viewport background colour and the terrain resolution can be set from within the Symbology tab.

Raster Map Layer Properties

The Raster Map Layer displays a raster map file and directly interacts with other layers (e.g., location, sequence, tree). The Map Layer properties dialog controls settings such as map layer metadata (e.g., name, description), colour scheme and rendering detail. Metadata from the map file (e.g., dimensions, origin) is also displayed. At this time, GenGIS supports a single map layer per session. Components of the Map Layer properties dialog are explained in greater detail below.

General Tab
MapLayer1.png
The General tab contains three editable layer metadata fields: Layer name, Description, and Authors. Changing the layer name also changes the name of the layer within the Layer Tree Controller.
Symbology > Colour Map Tab
MapLayer2.png
The Colour Map tab provides controls to change the map colour scheme, where distinct colours represent differences in terrain elevation.
  • The Colour map drop down menu provides pre-selected colour themes.
  • The Interpolation drop down menu controls whether colours are "blended" (linear mode) or applied in distinct bands (discrete mode).
  • The Number Entries controller specifies the number of distinct colour layers.
  • Individual colours and their corresponding elevation can be adjusted in the nested window containing colour buttons.
  • Colour-to-elevation representation can be evenly distributed by clicking the Evenly space entries button.
Symbology > Advanced Tab
MapLayer22.png
  • Display properties such as vertical exaggeration, level of map detail and transparency can be adjusted within the Advanced tab.
  • A wireframe mode checkbox displays the map as a transparent wireframe.
Metadata Tab
MapLayer4.png
  • Metadata from the map file (e.g., dimensions, origin) are visible within the Metadata tab.
Cartogram Tab
MapLayer3.png
  • Create a cartogram based on one or all of the location layers.
  • Vector layers can also be distorted with the map.
  • Location Radius prescribes the area each location's value covers.
  • Variable Multiplier increases the magnitude of each locations value.
  • Resize Density Matrix reduces the resolution of the map for cartogram creation. This reduces resource requirements and improves runtime, but introduces inaccuracies into the finalized map.

Creating a Cartogram

Cartograms are geographic visualization techniques which transfer the distribution of land area in a map from distance to another parameter of interest (such as population). This display technique has been integrated into GenGIS based on the diffusion-based cartogram. To create a cartogram a map and location layer are required. Additional location and vector layers can be transformed with the raster layer. To create a cartogram the Location Radius and Variable Multiplier must be set to some level. Location Radius defines the level of geographic preservation at a regional scale, while Variable Multiplier applies more distortion locally.

Cartogram.png

Vector Map Layer Properties

The Vector Map Layer displays a shapefile. One or more than one Shapefiles can be loaded and visuialized in GenGIS. The Vector Map Layer properties dialog controls settings such as vector map layer metadata (e.g., name, description) and visual properties for shapefile features. Metadata for each shapefile (e.g., projection, number of features,...) is also organized and displayed. Components of the Vector Map Layer properties dialog are explained in greater detail below.

General Tab
V200 VectorMapProperties General.png
The General tab contains three editable layer metadata fields: Layer name, Description, and Authors. Changing the layer name also changes the name of the layer within the Layer Tree Controller.
Symbology > Point Tab
V200 VectorMapProperties Symbology Point.png
The Point tab provides controls to change the size, shape, border colour, filling colour, and border size of point features.
Symbology > Polyline Tab
V200 VectorMapProperties Symbology Polyline.png
The Polyline tab provides controls to change the line style, colour, thickness, border size, and border colour of line features.
Symbology > Polygon Tab
V200 VectorMapProperties Symbology Polygon.png
The Polygon tab provides controls to change the style, thickness, and colour for the border line of polygon features.
Metadata Tab
V200 VectorMapProperties Metadata.png
Metadata from the shapefile (e.g., projection, features type) are visible within the Metadata tab.

Location Set Layer Properties

A location file is treated as a location set layer containing several distinct location layers. The Location Set Layer properties dialog controls settings such as location set layer metadata (e.g., name, description) and visual properties for both locations and charts (e.g., colour, size). Metadata from the location file (e.g., number of sites) is also displayed. At this time, GenGIS supports a single location file per session. Components of the Location Set Layer properties dialog are explained in greater detail below.

General Tab
V200 LocationSetProperties General.png
The General tab contains three editable layer metadata fields: Layer name, Description, and Authors. Changing the layer name also changes the name of the layer within the Layer Tree Controller.
Location Set > Colour Tab
V200 LocationSetProperties LocationSet Colour.png
The colour tab provides controls to modify location colour.
  • All locations can be displayed in a uniform colour by selecting the Uniform colour check-box.
  • Alternatively, each location can assigned a unique colour based on a property (e.g., environment type). This is performed by un-selecting the Uniform colour check-box and selecting appropriate Field to char and Colour map fields.
  • Individual colours for locations can be adjusted in the nested window containing rows of colour buttons.
  • Controls to modify location border colour and width are also provided.
Location Set > Shape Tab
V200 LocationSetProperties LocationSet Shape.png
The shape tab provides controls to modify location shape.
  • All locations can be displayed in a uniform shape by selecting the Uniform shape check-box.
  • Alternatively, each location can assigned a unique shape based on a property (e.g., environment type). This is performed by un-selecting the Uniform shape check-box and selecting appropriate Field to char and Shape map fields.
  • Individual shapes for locations can be adjusted in the nested window containing rows of shape selection menus.
Location Set > Size Tab
V200 LocationSetProperties LocationSet Size.png
The size tab provides controls to modify location size.
  • Each location can assigned a unique size based on a numeric property (e.g., easting). This is performed by selecting a value from Field to chart and assigning distinct minimum and maximum values.
Location Set > Label Tab
V200 LocationSetProperties LocationSet Label.png
Visibility and properties of labels stored in location files can be configured from within the Label tab.
  • If location charts are enabled, labels can be bound to the charts by selecting the Bind labels to charts check-box.
Charts > Colour Map Tab
V200 LocationSetProperties Charts ColourMap.png
  • GenGIS supports bar charts and pie charts to represent sequence data within locations.
  • Chart colour themes can be controlled from within the Colour Map tab.
  • Different sequence metadata fields can be selected for graphing using the Field to chart menu.
  • Charts can be enabled from either the Colour Map or Symbology tabs by selecting the Show charts check-box.


Note: Sequence data must be present in order to use the Colour Map tab controls.

Charts > Symbology (1) Tab (Chart type: Bar Chart)
V200 LocationSetProperties Charts Symbology BarChart.png
  • Chart size, position and background colour are all accessible through controls within the Symbology tab.
  • Droplines visually connect locations with their corresponding charts. Dropline style, thickness and colour controls are located within the Symbology tab.
  • Charts can be enabled from either the Colour Map or Symbology tabs by selecting the Show charts check-box.


Note: Sequence data must be present in order to use the Symbology tab controls.

Charts > Symbology (2) Tab (Chart type: Pie Chart)
V200 LocationSetProperties Charts Symbology PieChart.png
  • Different controls are available depending on the type of chart selected.


Note: Sequence data must be present in order to use the Symbology tab controls.

Grid > Colour Tab
GriddingColour.png

The colour tab provides controls to modify tile colour.

  • All tiles can be displayed in a uniform colour by selecting the Uniform colour radio-button.
  • Alternatively, each tile can be assigned a unique colour based on a property(e.g., Cell ID). This is performed by selecting the Colour Map radio button and selecting appropriate Field to chart and Colour map fields.
  • Tiles that do not contain values will be given a default colour. This can be changed with the Default Colour colour picker. The opacity of theses default tiles can be changed with the Default Opacity slider.
  • Individual colours for locations can be adjusted in the nested window containing rows of colour buttons.
  • Controls to modify location border colour, width, opacity and style are also provided.
Grid > Custom Tab
GriddingCustom.png

The custom tab provides controls to modify the size, alignment, elevation and combination method of tiles.

  • The Map can be divided by size or divisions based on Tile Size radios. Division orientation and division granularity can be selected here.
  • Grids can be aligned here to the maps origin, any active location, or coordinates on the map.
  • Map elevation can be controlled manually with the Auto adjust to map elevation check box.
  • Tile Fields changes how different metadata are combined in tiles.
Polygon Tab
LocationSetProperties Polygons.PNG

The polygon tab provides controls to visualize location data as polygons.

  • Polygons can be activated by checking the Draw Polygons checkbox, which will draw a polygon using all active locations.
  • The method being used to draw the polygons, along with its description, is determined by the chosen Algorithm.
  • General properties of the polygon include its opacity, whether its edges are straight or curved, and its elevation.
  • If the polygon is not auto adjusted to the map elevation, then a custom elevation can be specified in the box labeled Vertical Elevation.
  • In addition, if the Increasing Elevation checkbox is checked, then each polygon will be drawn at an increasing height above the map. The change in height between each polygon is determined by the value in the box labeled Elevation Offset.
  • Polygon sizing options include inflation and scaling. Polygon inflation will expand the polygon outward by a constant amount from each vertex while polygon scaling will expand the polygon outward using the scaling factor in the text box.
  • Borders of the polygons will be drawn if the Show Borders checkbox is checked. Controls to modify these borders include opacity and thickness.
Metadata Tab
V200 LocationSetProperties Metadata.png
  • Metadata from the location file (e.g., number of sites) is visible within the Metadata tab.


Location Layer Properties

Properties of individual locations are accessible through the Location Layer Properties dialog. Components of the properties dialog are explained in greater detail below.

General Tab
V200 LocationProperties General.png
The General tab contains three editable layer metadata fields: Layer name, Description, and Authors. Changing the layer name also changes the name of the layer within the Layer Tree Controller.
Symbology Tab
V200 LocationProperties Symbology.png
  • Location shape, size and colour can be controlled from within the Symbology tab.
  • Controls for label properties are also provided.
Metadata Tab
V200 LocationProperties Metadata.png
  • Metadata from the location file (e.g., comments) is visible within the Metadata tab.

Sequence Layer Properties

The Sequence Properties dialog provides controls to modify sequence layer metadata (e.g., name, description) and also displays sequence file metadata. Components of the Sequence Layer properties dialog are explained in greater detail below.

General Tab
V200 SequenceProperties General.png
The General tab contains three editable layer metadata fields: Layer name, Description, and Authors. Changing the layer name also changes the name of the layer within the Layer Tree Controller.
Metadata Tab
V200 SequenceProperties Metadata.png
  • Metadata from the sequence file (e.g., division) is visible within the Metadata tab.

Tree Layer Properties

GenGIS supports 2D and 3D trees (e.g., phylogenetic or hierarchical cluster tree). Different display properties (e.g., colour, line width) can be assigned to trees through the Tree Layer Properties dialog. GenGIS supports loading multiple trees during a single session. Components of the Tree Layer properties dialog are explained in greater detail below.

General Tab
V200 TreeProperties General.png
The General tab contains three editable layer metadata fields: Layer name, Description, and Authors. Changing the layer name also changes the name of the layer within the Layer Tree Controller.
Symbology > Tree Tab
V200 TreeProperties Symbology Tree.png
  • Tree layout and style properties can be set from within the Tree tab.
Symbology > Connecting Lines Tab
V200 TreeProperties Symbology ConnectingLines.png
  • Location, correlation and 3D drop line properties can be set from within the Connecting Lines tab.
Symbology > Geography Line Tab
V200 TreeProperties Symbology GeographyLine.png
  • Geography line and geographic point properties can be set from within the Geography Line tab.
Label Tab
V200 TreeProperties Label.png
  • Tree label size, colour and visibility can be set from within the Label tab.
Metadata Tab
V200 TreeProperties Metadata.png
  • Metadata from the tree file (e.g., number of nodes) is visible within the Metadata tab.

Graphical analysis tools in GenGIS

Basic data visualizations

GenGIS provides a number of ways to visualize data. Chief among these are visualizing summaries of sequence data as charts, and visualizing the relationship between location specific data as 2D or 3D trees. Other visualization are implemented as plugins and custom visualization can be generated through the Python interface.

Visualizing sequence data as charts

GenGIS supports both bar charts and pie charts to represent sequence data within locations. Charts are configured through Chart tab of the Location Set Layer Properties dialog. The sequence metadata field to graph is set through the Field to chart combobox. The colour assigned to each field element depends on the selected colour map and can be customized as desired. If your Sequence File contains a field indicating the number of times each sequence type was identified at a given location this can be set through the Create quantitative charts using count data in field combobox. By enabling or disabling this feature, qualitative (richness) and quantitative (evenness) pie charts can easily be created. The Symbology tab allows one to specify the type of chart to create and to set properties effecting the appearance of charts. In particular, the size of charts can be set to reflect the number of sequences obtained at a location by enabling the Set chart size proportional to number of sequences checkbox. For pie charts, the abundance at which sequence types (e.g., taxa) are assigned to the Other category is set through the Assign taxa to other field.

Charts > Colour Map Tab
V200 LocationSetProperties Charts ColourMap.png
Charts > Symbology (1) Tab (Chart type: Bar Chart)
V200 LocationSetProperties Charts Symbology BarChart.png
Charts > Symbology (2) Tab (Chart type: Pie Chart)
V200 LocationSetProperties Charts Symbology PieChart.png

3D Trees

Trees in Newick file format can be loaded into GenGIS. Leaf nodes within a tree must match up with either a Site ID from the location file or a Sequence ID from the sequence file. By default, trees are shown as 3D geophylogenies:

2D and 3D geophylogeny of Banza katydids from the Hawaiian Islands (data by Shapiro et al.)

The visual properties of 3D trees are highly customizable and can be modified through the Tree Layer Properties dialog.

2D Trees

GenGIS supports the quantitative visualization of 2D trees which can be used as an exploratory tool. Specifically, users can define a geographic axis and visualize how well the topology of a tree correlates with the ordering of geographic locations along this axis. This is accomplished by finding the ordering of leaf nodes, subject to the constraints of the tree topology, which minimizes the number of crossings that occur between lines that connect leaf nodes to their associated geographic locations. In this optimal layout, the number of crossings that occur between these lines is a quantitative measure of the amount of discordance which exists between the topology of the tree and the user defined geographic axis. Further information about this quantitative 2D visualization technique can be found in:

  • Parks DH and Beiko RG. 2009. Quantitative visualizations of hierarchically organized data in a geographic context. Geoinformatics 2009, Fairfax, VA. (Abstract)
  • Parks DH, Porter M, Churcher S, Wang S, Blouin C, Whalley J, Brooks S, and Beiko RG. 2009. GenGIS: A geospatial information system for genomic data. Genome Research, 19: 1896-1904. (Abstract)
Biodiveristy of 19 marine metagenomes from the Global Ocean Sampling expedition visualized using a 2D hierarchical clustering tree.

Defining axes

To generate a 2D tree, a Layout Line must first be drawn. Select the Layout Line from the main toolbar, click on the map where you would like the line to start, and then click again where you would like the line to end. The 2D tree will always be drawn on the right-hand side of the Layout Line as you walk from the start to the end of the line. To generate a 2D tree, right-click on the Tree Layer in the Layer Tree and select 2D slanted cladogram, 2D cladogram, or 2D phylogram from the pop-up menu.

If you wish to specify a non-linear geographic axes, select Draw geographic axis from the main toolbar. You can now draw a polyline within the Viewport by clicking on the desired start and end points of individual line segments. Press Enter when you are finished drawing the polyline. You can right-click on any polyline vertex and select Extend geographic axis to draw more complicated non-linear axes. Note that only locations which reside close to the specified polyline are considered and all other locations are projected out of the tree.

V200 icon line.png Draw layout line Draw a straight line which can be used to layout graphic elements such as a 2D tree or pie charts.
V200 icon polyline.png Draw geographic axis Draw a polyline which can be used to test the goodness-of-fit between a tree and a non-linear geographic axes (see 2D Pylogenetic Trees).

Manipulation

The geographic axis being evaluated can be modified dynamically. To modify the geographic axis, simple click on either of the end-points of the Layout Line and drag it to a new location. The vertices defining a non-linear geographic axes can also be modified dynamically. Making the Layout Line shorter will reduce the size of the 2D tree. The height of the tree can also be modified in the Tree Layer Properties dialog. You can also drag the root node of a tree to re-position the tree while keeping the Layout Line at the same orientation.

Zoom into a Sub-tree

Displays the sub-tree defined by the selected node.

Original tree:
Zoom1.png
Zoomed in:
Zoom2.png

Collapse a Sub-tree

Displays the sub-tree defined by the selected node as a wedge, coloured by the proportional content of all child leaf nodes.

Original tree:
Collapse1.png
Tree with collapsed nodes:
Collapse2.png

Split a Sub-tree

Removes a sub-tree defined by the highest selected node from the original tree. This node becomes the root node in a new separated tree.

Original tree:
Split1.png
Resulting trees:
Split2.png

Visual Properties

The visual properties of 2D trees are highly customizable and can be modified through the Tree Layer Properties dialog.

Statistical Test

A Monte Carlo permutation test can be used to test whether or not the fit of ordered leaf nodes to geographic points is significantly better than expected by chance alone. This null hypothesis is tested by holding the tree topology, geographic axis, and the association between leaf nodes and geographic locations constant while permuting the ordering of geographic locations along the geographic layout line. After each random permutation, the new optimal ordering of leaf nodes is determined and the number of edge crossings is determined. By generating many random permutations, we obtain an estimate of the probability mass function of the null model. The reported p-value is the fraction of permutations that have a number of crossings fewer than or equal to the number of crossings in the original model. Note: this explanation differs slights from the one given in Parks and Beiko, 2009 where the association between leaf nodes and geographic locations was permuted. In practice, this results in the same null distribution though special care must be taken to properly handle geographic locations which are associated with multiple leaf nodes.

To perform a Monte Carlo permutation test, right-click on the Tree Layer in the Layer Tree and select Perform significant test (on full tree) from the pop-up menu. The permutation test can also be applied to any subtree by right clicking on the root node of the subtree and selecting Perform significant test on subtree from the pop-up menu. The results of the permutation test are shown as a graph which indicates the calculated p-value along with the estimated probability density function. The number of crossings occuring on the actual data is shown by a red line.

Plot showing results of a Monte Carlo permutation test.

Linear Axes Analysis

GenGIS allows the number of crossing which occur for all linear gradients to be explored. Right-click on the subtree of the geophylogeny you wish to analyze and select Perform linear axis analysis on subtree. This will produce a graph showing the number of crossings which occur for all possible linear gradients. Clicking on the graph causes the linear layout line to rotate to a given orientation. Running a permutation test causes a red line to be drawn on the plot which indicates the number of crossings at which the specified critical value (i.e., p-value = 0.05) is obtained. That is, linear gradients with orientations resulting in fewer crossings are significant at the selected p-value.

Graph showing the number of crossings for all possible linear gradients.

The Python console and API functions

What you can do with the console

The Python Console provides access to a standard Python interpreter. Python is a general-purpose high-level programming language with many packages available for phylogenetics, population genetics, and statistics. Data loaded into GenGIS is exposed to the Python Console allowing quanitative hypothesis testing to be performed directly within GenGIS. Results of analyses can be visualized within the Viewport to aid in interpretation of results and generation of new hypotheses.

Below we give several short examples of using this API. You can also find information about using the API on our tutorials page.

Accessing location site and sequence data

Location site and sequence data can be accessed directly from the Python Console. You can access all location layers using: 

 locLayers = GenGIS.layerTree.GetLocationSetLayer(0).GetAllLocationLayers()

If you wish to get a list of only the active location layers (i.e., those which are checked), use: 

 activeLocLayers = GenGIS.layerTree.GetLocationSetLayer(0).GetAllActiveLocationLayers()

Properties of a location are accessed through its controller: 

 locController = locLayers[0].GetController()

A list of functions supported by the location controller can be obtained with: 

 dir(locController)

The metadata associated with a location is accessed as a python dictionary: 

 metadata = locController.GetData()
 metadata.keys()
 metadata['Site ID']

All sequence layers or all active sequence layers associated with a location layer can be accessed using: 

 seqLayers = locLayers[0].GetAllSequenceLayers()
 activeSeqlayers = locLayers[0].GetAllActiveSequenceLayers()

Analogous to location data, data associated with a sequence is accessed through the sequence controller: 

 seqController = seqLayers[0].GetController()
 metadata = seqController.GetData()
 metadata.keys()
 metadata['Sequence Id']

Filtering data

We have provided a simple function, filterData, for filtering data. This function is contained in dataHelper.py. As an example, all locations with a temperature greater than 20 can be obtained as follows: 

import dataHelper
locLayers = GenGIS.layerTree.GetLocationSetLayer(0).GetAllLocationLayers()
filteredLocLayers = dataHelper.filter(locLayers, 'Temperature', 20, dataHelper.filterFunc.greater)

The function filter takes 4 parameters:

  • the data to be filtered
  • the field to filter on
  • the value to filter on
  • a filtering function which returns true for all items passing the filter

Filtering can be done on either strings or numeric values: 

import dataHelper
seqLayers = locLayers[0].GetAllSequenceLayers()
filteredSeqLayers = dataHelper.filter(seqLayers, 'Phylum', 'Actinobacteria', dataHelper.filterFunc.equal)

Basic filtering functions are provided in filterFunc.py, but it is easy to write your own filtering functions. For example, the equal filter used above is simply: 

def equal(val1, val2):
  return str(val1) == str(val2)

Creating custom data visualizations

Using the VisualLine, VisualMarker, and VisualLabel classes one can create custom data visualizations with GenGIS. The VisualLine class allows user defined lines to be drawn in the Viewport. Suppose we have two locations within our location set with ids of 'GBR' and 'ITA'. We can draw a line between these locations as follows: 

# get location layers
locLayers = GenGIS.layerTree.GetLocationSetLayer(0).GetAllLocationLayers()

# create a dictionary indicating the geographic coordinates of each location 
locDict = {}
for loc in locLayers:
  locDict[loc.GetController().GetId()] = [loc.GetController().GetLongitude(), loc.GetController().GetLatitude()]

# get the 3D position of GBR and ITA
terrainController = GenGIS.layerTree.GetMapLayer(0).GetController()
gbrPt = GenGIS.Point3D()
terrainController.GeoToGrid(GenGIS.GeoCoord(locDict['GBR'][0], locDict['GBR'][1]), gbrPt)

itaPt = GenGIS.Point3D()
terrainController.GeoToGrid(GenGIS.GeoCoord(locDict['ITA'][0], locDict['ITA'][1]), itaPt)

# draw a solid red line with a width of 2 between these countries
line = GenGIS.VisualLine(GenGIS.Colour(1,0,0), 2, GenGIS.LINE_STYLE.SOLID, GenGIS.Line3D(gbrPt, itaPt))
lineId = GenGIS.graphics.AddLine(line)			
GenGIS.viewport.Refresh()

The visual properties of this line can easily be changed at any time to reflect different aspects of your data: 

line.SetColour(GenGIS.Colour(0,1,0))
line.SetThickness(5)
line.SetLineStyle(GenGIS.LINE_STYLE.SHORT_DASH)
GenGIS.viewport.Refresh()

We can later remove this line using: 

GenGIS.graphics.RemoveLine(lineId)
GenGIS.viewport.Refresh()

The VisualMarker class allows user defined markers to be drawn in the Viewport. It is similar to the VisualLine class. For example, we can draw a blue circle over London which is situated at a longitude 0.128W and a latitude of 51.51N as follows: 

# get 3D position of geographic coordinate in Viewport
terrainController = GenGIS.layerTree.GetMapLayer(0).GetController()
pt = GenGIS.Point3D()
terrainController.LatLongToGrid(GenGIS.GeoCoord(-0.128, 51.51), pt)
marker = GenGIS.VisualMarker(GenGIS.Colour(0,0,1), 6, GenGIS.MARKER_SHAPE.CIRCLE, pt)
markerId = GenGIS.graphics.AddMarker(marker)
GenGIS.viewport.Refresh()

VisualLabels can be used to create orthographic (e.g., to indicate a legend or figure caption) or perspective text (e.g., to label points on a map). We can create a "Hello World!" label for a map as follows: 

label = GenGIS.VisualLabel("Hello World!", GenGIS.Colour(0,0,0), 12, GenGIS.LABEL_RENDERING_STYLE.ORTHO)
label.SetScreenPosition(GenGIS.Point3D(20,20,1))
labelId = GenGIS.graphics.AddLabel(label)
GenGIS.viewport.Refresh()

Alternatively, we can use a VisualLabel to label our marker at London: 

terrainController = GenGIS.layerTree.GetMapLayer(0).GetController()
label = GenGIS.VisualLabel("London", GenGIS.Colour(0,0,0), 12, GenGIS.LABEL_RENDERING_STYLE.PERSPECTIVE)
pt = GenGIS.Point3D()
terrainController.LatLongToGrid(GenGIS.GeoCoord(-0.128, 51.51), pt)
label.SetGridPosition(pt)
labelId = GenGIS.graphics.AddLabel(label)
GenGIS.viewport.Refresh()

A label can be removed with: 

GenGIS.graphics.RemoveLabel(labelId)
GenGIS.viewport.Refresh()

By combining these graphical primative and encoding key aspects of your data to different visual properties (i.e., colour, size, shape) GenGIS can be used to identify interesting patterns within a wide-range of datasets. An example which uses these classes to visualizing a distance matrix indicating the rate of import and export of HIV-1 subtype B for different European countries as reported by Paraskevis et al. (2009) is available here.

Creating fly-through movies

A collection of functions for creating fly-through movies are available in movieHelper.py found in the scripts directory. A useful movie is to rotate the map about its origin. Such a movie can be made using the rotateAboutOrigin function which takes the number of degrees to rotate and the time of the movie as parameters: 

import movieHelper
movieHelper.rotateAboutOrigin(360, 10)

More general movies can be created by capturing the camera parameters at key frames using the function getCameraParam and then interpolating between these key frames using the function linearInterpolateParams: 

import movieHelper 
# move camera to first key frame (for example, use the toolbar to set a top down view)
keyFrame1 = movieHelper.getCameraParam()
# move camera to next key frame (for example, use the toolbar to set the default perspective view)
keyFrame2 = movieHelper.getCameraParam()
# set camera back to first key frame
movieHelper.setCameraParam(keyFrame1)
# smoothly move between these key frames in 5 seconds
movieHelper.linearInterpolateParams(keyFrame1, keyFrame2, 5)

For examples of creating custom movies which do not use the movieHelper API, have a look at the series of H1N1 movies we have developed. In particular, note that GenGIS.mainWindow.Yield() must be called occasionally for time series to run correctly.

By stitching together multiple key frames complex fly-through movies can be created. Commercial software such as Camtasia or open source software such as CamStudio can be used to record these movies.

RPy and analyzing data

GenGIS makes use of the [RPy2 libraries which allow R commands to be embedded in Python. If you are familiar with R, then the key to operating at the interface of GenGIS, Python and R is understanding how to ensure data are in the right scope.

Important: GenGIS is built with a version of RPy2 (2.03) that is quite a bit older than the current release. This should not prevent you from doing analyses with RPy2, but it does mean that the current RPy2 documentation is not relevant. We recommend referring to documentation in the 2.0 series, for instance the [Version 2.08 documentation].

  • Data managed by GenGIS need to be retrieved into the Python environment using the GenGIS API functions.
  • Data in the Python environment need to be passed to R in one of two ways by passing the Python data structure to R either before the desired analysis is invoked, or at the time of invocation. The choice of approach depends on what the R call is looking for: in general it is less elegant but easier to set everything in advance.

More-detailed examples of how to do this are shown in the tutorials, and plugins such as the Mantel test that use R can be mined for additional working examples.

The first step is to import RPy2 and set up a shortcut for invoking R commands. This is accomplished with the following commands: 

import rpy2
import rpy2.robjects as robjects
r = robjects.r

If this works, then any R command can be invoked using the syntax r("command"). It is important to remember, though, that everything inside the quotation marks needs to be in R's scope.

Here is the general procedure to follow for getting data from Python into R:

  • First, create the Python data structure. For example, if the ultimate goal is an R vector, then you can start out with a Python list:
pyList = [1,2,2,3,3,4,4,4,4,5,5,5,6,6,6,6,6,7,8,8,9,10,10]
  • Second, use rpy2 to create an R data structure that is visible in Python (but not yet in R!).
rVecInPy = r["c"](robjects.IntVector(pyList))

This uses the R command c() to create an integer vector. We now have an R data structure, but R can't see it yet!

  • Third, create a version of the data structure in the R environment. We do this by setting values in robjects.globalEnv:
robjects.globalEnv["rVecInR"] = rVecInPy

Now we have a copy of the R array in the R environment, so we can use the variable embedded within quotation marks in an r("") command: 

r("hist(rVecInR)")

This will create a frequency histogram using the default parameters. Any parameters of hist() can be set inside the double quotes as they would be in a native R environment.

Retrieved from "https://beikolab.cs.dal.ca/gengis/?title=The_GenGIS_2.5_Manual&oldid=2243"