-
Notifications
You must be signed in to change notification settings - Fork 15
Home
- Modular design logically partitions analysis and expedites failure recovery
- Automated script generation eliminates syntax errors and ensures uniform execution
- Standardized OTU abundance tables facilitate analysis across datasets
- Batch scripts take advantage of parallelization on the cluster job queue
- Configuration file consolidates project details into a principal reference document (and can reproduce analysis)
- BioModule interface provides a flexible mechanism for adding new functionality
Package | Description |
---|---|
module.classifier | The classifier package contains the ClassifierModule interface, its default implementation ClassifierModuleImpl , and RDP, QIIME, KRAKEN, KRAKEN2, & MetPhlAn classifier modules. These modules output tables with OTU counts for each sample at each taxonomy level configured in report.taxonomyLevels. |
module.implicit | The implicit package contains modules that are added to user pipelines if BioLockJ deems them necessary based on pipeline input and configuration. These modules are ignored if found in the Config file until the override property is enabled: project.allowImplicitModules=Y. |
module.report.r | The r package generates R scripts to calculate statistics and build data visualizations based on OTU abundance tables. |
module.report | The report package modules are used to normalize OTU abundance tables, merge them with the metadata, and generate reports and notifications. |
module.seq | The seq package contains a collection of modules used to prepare sequence files and/or metadata prior to classification. |
- BioModules are Java classes that implement the the biolockj.module.BioModule interface.
- All modules inherit (directly or indirectly) from the default implementation biolockj.module.BioModuleImpl
BioLockJ: data-wrangling done right.
Getting Started
Dependencies
Installation
Configuration
Commands
Example Pipeline
Failure Recovery
Validation
Building Modules
API
FAQ
Sequence Processing Modules
AwkFastaConverter
Gunzipper
KneadDataSanitizer
Multiplexer
PearMergeReads
RarefySeqs
SeqFileValidator
TrimPrimers
Classifier Modules
for whole genome sequences
Humann2Classifier
KrakenClassifier
Kraken2Classifier
Metaphlan2Classifier
for 16S sequences
QiimeClosedRefClassifier
QiimeDeNovoClassifier
QiimeOpenRefClassifier
RdpClassifier
Report Modules
general
Email
JsonReport
for otu tables
CompileOtuCounts
RarefyOtuCounts
RemoveLowOtuCounts
RemoveScarceOtuCounts
for taxa tables
AddMetadataToOtuTables
BuildTaxaTables
LogTransformTaxaTables
NormalizeTaxaTables
for pathway tables
AddMetadataToPathwayTables
RemoveLowPathwayCounts
RemoveScarcePathwayCounts
for statistics and visualization
R_CalculateStats
R_PlotEffectSize
R_PlotMds
R_PlotOtus
R_PlotPvalHistograms