Difference between revisions of "Description of GenGIS plugins"

From The GenGIS wiki
Jump to navigationJump to search
Line 45: Line 45:
  
 
=Mantel=
 
=Mantel=
 +
 +
Requirements: ''R'' with the ''ade4'' R library must be installed on your system.
  
 
The ''Mantel'' plugin can be used to perform a Mantel test between any two variables in the ''Location Table'' or ''Sequence Table''.
 
The ''Mantel'' plugin can be used to perform a Mantel test between any two variables in the ''Location Table'' or ''Sequence Table''.

Revision as of 14:19, 5 March 2012

GenGIS provides the following Python plugins which can be accessed through the Plugins menu.

Alpha Diversity

The Alpha Diversity plugin calculates alpha diversity for active locations. It currently calculate richness, Shannon, and Simpson alpha diversity. To calculate alpha diversity, you must select the Measure you wish to calculate and the Category field in your sequence file over which diversity will be calculate (Fig. 1). You may optionally select a Count field which indicates the number of times a given sequence is observed at a location. Pressing Calculate causes alpha diversity to be calculated. Results are reported within the plugin and added to the location table for use within GenGIS and other plugins.

Figure 1. Alpha Diversity plugin.

Alpha Diversity Visualizer

The Alpha Diversity Visualizer plugin can calculate alpha diversity for active locations, regress alpha diversity against location specific metadata, and produce visualizations of the resulting linear regression analysis. It currently calculate richness, Shannon, and Simpson alpha diversity. To calculate alpha diversity, you must select the Measure you wish to calculate and the Category field in your sequence file over which diversity will be calculate (Fig. 2). You may optionally select a Count field which indicates the number of times a given sequence is observed at a location. Pressing Calculate causes alpha diversity to be calculated. Linear regression results of alpha diversity versus all numeric fields associated with locations are reported within the Linear Regression Results table. Selecting a row within this table causes a linear regression scatter plot of alpha diversity versus the selected Field to be generated. The Viewport Display section allows different Viewport visualization to be produced.

Figure 2. Alpha Diversity Visualizer plugin.

Dissimilarity Matrix Viewer

The Dissimilarity Matrix Viewer plugin provides functionality for visualizing a matrix which indicates the dissimilarity between all pairs of locations. The dissimilarity matrix must be in the following format, where a \t indicates a tab:

 3
A\t0\t2\t3
B\t1\t0\t4
C\t3\t5\t0

The first line indicates the number of locations and each of the following rows gives the dissimilarity values for the specified location. The location names (first column) must match those in your location file. The upper and lower triangles of the matrix can be different. For example, in this HIV-1 data set, the two triangle indicate import and export rates.

Elements in the matrix are selected by setting the Selection criteria (Fig. 3). Lines between the selected pairs are displayed in the Viewport using the specified Visual properties (Fig. 4). To update the Viewport display click Apply.

Figure 3. Dissimilarity Matrix Viewer plugin.
Figure 4. Display of all matrix elements between 5 and 10.

Linear Regression

The Linear Regression plugin can be used to perform a linear regress between any two variables in the Location Table (see Location Table Viewer below). To perform the regression, the independent and dependent variables must be specified in the Regression analysis section of the plugin (Fig. 5). The results of the regression are reported within the plugin and shown as a scatter plot. A visualization within the GenGIS Viewport is also generated based on the properties set in the Viewport display section of the plugin (Fig. 6).

Figure 5. Linear Regression plugin.
Figure 6. Residuals of linear regression shown within the GenGIS Viewport.

Location Table Viewer

The Location Table Viewer plugin display a table indicating the metadata associated with each location (Fig. 7). Other plugins and custom Python scripts can be used to add data to the Location Table. By default, only data for active locations is shown. To show data for all locations check the Show data for all locations checkbox.

Figure 7. Location Table plugin.

Mantel

Requirements: R with the ade4 R library must be installed on your system.

The Mantel plugin can be used to perform a Mantel test between any two variables in the Location Table or Sequence Table.

Figure 8. Mantel plugin.

Sequence Table Viewer

The Sequence Table Viewer plugin display a table indicating the metadata associated with each sequence (Fig. 9). Other plugins and custom Python scripts can be used to add data to the Sequence Table. By default, only data for active locations and active sequences is shown. To show data for all locations check the Show data for all locations checkbox. To show data for all sequences check the Show data for all sequences checkbox.

Figure 9. Sequence Table plugin.