biolockj.module.report.r

Class R_PlotEffectSize

java.lang.Object

biolockj.module.BioModuleImpl

biolockj.module.ScriptModuleImpl

biolockj.module.report.r.R_Module

biolockj.module.report.r.R_PlotEffectSize

All Implemented Interfaces:

ApiModule, BioModule, ScriptModule, Comparable<BioModule>

public class R_PlotEffectSize
extends R_Module
implements ApiModule

This BioModule is used to run the R script used to generate OTU-metadata fold-change-barplots for each binary report field. A pdf is created for each taxonomy level.

GUI Module Name

R Plot Effect Size

Field Summary

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
R_PlotEffectSize()

Method Summary

Modifier and Type	Method and Description
void	checkDependencies() At least one of the available plot types should NOT be disabled.
String	getCitationString() At a minimum, this should return the name and/or url for the wrapped tool.
String	getDescription() Briefly describe what this module does.
protected String	getModulePrefix() Returns that prefix to use for property names.
protected String	getModuleRScriptName()
List<String>	getPreRequisiteModules() Returns Constants.DEFAULT_STATS_MODULE and if fold change plots are to be generated, add NormalizeTaxaTables

Methods inherited from class biolockj.module.report.r.R_Module

buildScript, calcTimeout, cleanUp, executeTask, getCustomScriptProp, getDockerImageName, getDockerImageOwner, getDockerImageTag, getFunctionLib, getFunctionLib, getModuleRScript, getTimeout, grapRUsedProps, requiredRPackages

Methods inherited from class biolockj.module.ScriptModuleImpl

buildScriptForPairedReads, getJobParams, getMainScript, getRuntimeParams, getScriptDir, getScriptErrors, getSummary, getWorkerScriptFunctions, hasScripts, isValidProp

Methods inherited from class biolockj.module.BioModuleImpl

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface biolockj.api.ApiModule

getDescription, getDetails, getMenuPlacement, getPropType, getTitle, isValidProp, listProps

Methods inherited from interface biolockj.module.BioModule

cleanUp, executeTask, getAlias, getDockerImageName, getDockerImageOwner, getDockerImageTag, getID, getInputFiles, getLogDir, getMetadata, getModuleDir, getOutputDir, getPostRequisiteModules, getPropDefault, getResourceDir, getSummary, getTempDir, init, isValidInputModule, setAlias, version

Constructor Detail

R_PlotEffectSize

public R_PlotEffectSize()

Method Detail

checkDependencies

public void checkDependencies()
                       throws Exception

At least one of the available plot types should NOT be disabled.

Specified by:

checkDependencies in interface BioModule

Overrides:

checkDependencies in class R_Module

Throws:

Exception - thrown if missing or invalid dependencies are found

getPreRequisiteModules

public List<String> getPreRequisiteModules()
                                    throws Exception

Returns Constants.DEFAULT_STATS_MODULE and if fold change plots are to be generated, add NormalizeTaxaTables

Specified by:

getPreRequisiteModules in interface BioModule

Overrides:

getPreRequisiteModules in class BioModuleImpl

Returns:

List of BioModule Class Names

Throws:

Exception - if invalid Class names are returned as prerequisites

getDescription

public String getDescription()

Description copied from interface: ApiModule

Briefly describe what this module does. A more detailed description may be returned by getDetails.

Specified by:

getDescription in interface ApiModule

Returns:

getCitationString

public String getCitationString()

Description copied from interface: ApiModule

At a minimum, this should return the name and/or url for the wrapped tool. For BioLockJ home-grown modules, it can cite BioLockJ and give the current version. Ideally this will include the version for the wrapped tool. Tool version may require using a stored variable that can be filled in during execution; and the string that is returned pre-execution may not have the version.

Specified by:

getCitationString in interface ApiModule

Returns:

getModuleRScriptName

protected String getModuleRScriptName()

Specified by:

getModuleRScriptName in class R_Module

getModulePrefix

protected String getModulePrefix()

Description copied from class: R_Module

Returns that prefix to use for property names.

Specified by:

getModulePrefix in class R_Module

Returns: