biolockj.module.report.humann2

Class RemoveScarcePathwayCounts

java.lang.Object

biolockj.module.BioModuleImpl

biolockj.module.ScriptModuleImpl

biolockj.module.JavaModuleImpl

biolockj.module.report.humann2.Humann2CountModule

biolockj.module.report.humann2.RemoveScarcePathwayCounts

All Implemented Interfaces:

BioModule, JavaModule, ScriptModule, Comparable<BioModule>

public class RemoveScarcePathwayCounts
extends Humann2CountModule

This BioModule removes scarce pathways not found in enough samples.
Each pathway must be found in a configurable percentage of samples to be retained.

GUI Module Name

Remove Scarce Pathway Counts

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.BioModule

LOG_DIR, MAIN_SCRIPT_PREFIX, NO_VERSION, OUTPUT_DIR, RES_DIR, TEMP_DIR

Constructor Summary

Constructors

Constructor and Description
RemoveScarcePathwayCounts()

Method Summary

Modifier and Type	Method and Description
void	checkDependencies() Validate module dependencies: Require Config. exists Require Config. is positive integer Require Config. is positive integer Verify Config. is positive integer if set Start the AWS DB sync to S3 if a novel DB has been configure and "aws.copyDbToS3" is enabled
String	getSummary() Produce summary message with min, max, mean, and median number of pathways.
protected void	logScarceData(TreeMap<String,TreeSet<String>> map, File file) Save a list of low count pathways or samples to the module temp directory.
protected TreeMap<String,TreeSet<String>>	removeScarcePathwayCounts(File file, Set<String> scarcePathways) Remove Pathway Counts below the Config."report.minCount"
void	runModule() This method executes the modules primary Java routine.

Methods inherited from class biolockj.module.report.humann2.Humann2CountModule

getInputFiles, getPreRequisiteModules, isHumann2CountModule, isValidInputModule

Methods inherited from class biolockj.module.JavaModuleImpl

buildScript, executeTask, getDockerImageName, getDockerImageOwner, getDockerImageTag, getWorkerScriptFunctions, markStatus, moduleComplete, moduleFailed, runBioLockJ_CMD

Methods inherited from class biolockj.module.ScriptModuleImpl

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

Methods inherited from class biolockj.module.BioModuleImpl

addGeneralProperty, addGeneralProperty, addGeneralProperty, addNewProperty, addNewProperty, cacheInputFiles, cleanUp, compareTo, equals, findModuleInputFiles, getAlias, getDescription, getDetails, getFileCache, getID, getLogDir, getMenuPlacement, getMetadata, getModuleDir, getOutputDir, getPostRequisiteModules, getPropDefault, getPropDescMap, getPropType, getPropTypeMap, getResourceDir, getTempDir, getTitle, hashCode, init, listProps, setAlias, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

cleanUp, getAlias, getID, getLogDir, getMetadata, getModuleDir, getOutputDir, getPostRequisiteModules, getPropDefault, getResourceDir, getTempDir, init, setAlias, version

Constructor Detail

RemoveScarcePathwayCounts

public RemoveScarcePathwayCounts()

Method Detail

checkDependencies

public void checkDependencies()
                       throws Exception

Description copied from class: ScriptModuleImpl

Validate module dependencies:

• Require Config. exists
• Require Config. is positive integer
• Require Config. is positive integer
• Verify Config. is positive integer if set
• Start the AWS DB sync to S3 if a novel DB has been configure and "aws.copyDbToS3" is enabled

Specified by:

checkDependencies in interface BioModule

Overrides:

checkDependencies in class Humann2CountModule

Throws:

Exception - thrown if missing or invalid dependencies are found

getSummary

public String getSummary()
                  throws Exception

Produce summary message with min, max, mean, and median number of pathways.

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

logScarceData

protected void logScarceData(TreeMap<String,TreeSet<String>> map,
                             File file)
                      throws Exception

Save a list of low count pathways or samples to the module temp directory.

Parameters:

map - TreeMap(sampleId, TreeSet(data)) of Pathways found in too few samples or pathways

file - Output file

Throws:

Exception - if errors occur

removeScarcePathwayCounts

protected TreeMap<String,TreeSet<String>> removeScarcePathwayCounts(File file,
                                                                    Set<String> scarcePathways)
                                                             throws Exception

Remove Pathway Counts below the Config."report.minCount"

Parameters:

file - input file

scarcePathways - Set of pathway names to be eliminated

Returns:

TreeMap(SampleId, TreeMap(Pathway)) Map removed pathways to sample ID

Throws:

Exception - if errors occur