biolockj.module.report.taxa

Class BuildTaxaTables

java.lang.Object

biolockj.module.BioModuleImpl

biolockj.module.ScriptModuleImpl

biolockj.module.JavaModuleImpl

biolockj.module.report.otu.OtuCountModule

biolockj.module.report.taxa.BuildTaxaTables

All Implemented Interfaces:

BioModule, JavaModule, ScriptModule, Comparable<BioModule>

public class BuildTaxaTables
extends OtuCountModule

Many R BioModules expect separate tables containing log-normalized taxa counts for each taxonomy level. This module reads the most recent OTU count files generated by any previous BioModule.

GUI Module Name

Build Taxa Tables

Field Summary

Fields inherited from class biolockj.module.JavaModuleImpl

BLJ_OPTIONS

Fields inherited from class biolockj.module.BioModuleImpl

GZIP_EXT, LOG_EXT, PDF_EXT, RETURN, SH_EXT, TAB_DELIM, TSV_EXT, TXT_EXT

Fields inherited from interface biolockj.module.ScriptModule

SCRIPT_BATCH_SIZE, SCRIPT_DEFAULT_HEADER, SCRIPT_NUM_THREADS, SCRIPT_PERMISSIONS, SCRIPT_TIMEOUT

Fields inherited from interface biolockj.module.BioModule

MAIN_SCRIPT_PREFIX, OUTPUT_DIR, TEMP_DIR

Constructor Summary

Constructors

Constructor and Description
BuildTaxaTables()

Method Summary

Modifier and Type	Method and Description
protected void	buildTaxonomyTables(TreeMap<String,TreeMap<String,Long>> sampleOtuCounts) Build taxonomy tables from the sampleTaxaCounts.
String	getSummary() Returns summary message to be displayed by Email module so must not contain confidential info.
void	runModule() This method executes the modules primary Java routine.

Methods inherited from class biolockj.module.report.otu.OtuCountModule

getInputFiles, isOtuModule, isValidInputModule

Methods inherited from class biolockj.module.JavaModuleImpl

buildScript, executeTask, getSource, getWorkerScriptFunctions, markStatus, moduleComplete, moduleFailed

Methods inherited from class biolockj.module.ScriptModuleImpl

buildScriptForPairedReads, checkDependencies, getJobParams, getMainScript, getRuntimeParams, getScriptDir, getScriptErrors, getTimeout, hasScripts

Methods inherited from class biolockj.module.BioModuleImpl

cacheInputFiles, cleanUp, compareTo, equals, findModuleInputFiles, getFileCache, getID, getModuleDir, getOutputDir, getPostRequisiteModules, getPreRequisiteModules, getTempDir, init, toString, validateFileNameUnique

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface biolockj.module.ScriptModule

buildScriptForPairedReads, getJobParams, getMainScript, getScriptDir, getScriptErrors, getTimeout

Methods inherited from interface biolockj.module.BioModule

checkDependencies, cleanUp, getID, getModuleDir, getOutputDir, getPostRequisiteModules, getPreRequisiteModules, getTempDir, init

Constructor Detail

BuildTaxaTables

public BuildTaxaTables()

Method Detail

getSummary

public String getSummary()
                  throws Exception

Description copied from class: ScriptModuleImpl

Returns summary message to be displayed by Email module so must not contain confidential info. ModuleUtil provides summary metrics on output files

Specified by:

getSummary in interface BioModule

Overrides:

getSummary in class ScriptModuleImpl

Returns:

Summary of BioModule execution

Throws:

Exception - if any error occurs

runModule

public void runModule()
               throws Exception

Description copied from interface: JavaModule

This method executes the modules primary Java routine.

Specified by:

runModule in interface JavaModule

Specified by:

runModule in class JavaModuleImpl

Throws:

Exception - thrown if any runtime error occurs

buildTaxonomyTables

protected void buildTaxonomyTables(TreeMap<String,TreeMap<String,Long>> sampleOtuCounts)
                            throws Exception

Build taxonomy tables from the sampleTaxaCounts.

Parameters:

sampleOtuCounts - TreeMap(SampleId, TreeMap(OTU, count)) OTU counts for every sample

Throws:

Exception - if errors occur