Multiplexer#
Add to module run order:
#BioModule biolockj.module.seq.Multiplexer
Description#
Multiplex samples into a single file, or two files (one with forward reads, one with reverse reads) if multiplexing paired reads.
Properties#
Properties are the name=value pairs in the configuration file.
Multiplexer properties:#
| Property | Description |
|---|---|
| metadata.barcodeColumn | string metadata column with identifying barcodes -> Values should be unique. default: BarcodeSequence |
| multiplexer.gzip | boolean If enabled, the multiplexed output will be gzipped default: Y |
General properties applicable to this module:#
| Property | Description |
|---|---|
| cluster.batchCommand | string Terminal command used to submit jobs on the cluster default: null |
| cluster.jobHeader | string Header written at top of worker scripts default: null |
| cluster.modules | list List of cluster modules to load at start of worker scripts default: null |
| cluster.prologue | string To run at the start of every script after loading cluster modules (if any) default: null |
| cluster.statusCommand | string Terminal command used to check the status of jobs on the cluster default: null |
| docker.saveContainerOnExit | boolean If Y, docker run command will NOT include the --rm flag default: null |
| docker.verifyImage | boolean In check dependencies, run a test to verify the docker image. default: null |
| metadata.barcodeColumn | string metadata column with identifying barcodes -> Values should be unique. default: BarcodeSequence |
| script.defaultHeader | string Store default script header for MAIN script and locally run WORKER scripts. default: #!/bin/bash |
| script.numThreads | integer Used to reserve cluster resources and passed to any external application call that accepts a numThreads parameter. default: 8 |
| script.numWorkers | integer Set number of samples to process per script (if parallel processing) default: 1 |
| script.permissions | string Used as chmod permission parameter (ex: 774) default: 770 |
| script.timeout | integer Sets # of minutes before worker scripts times out. default: null |
Details#
version: 0.0.0 none
Adds modules#
pre-requisite modules
none found
post-requisite modules
none found
Docker#
If running in docker, this module will run in a docker container from this image:
biolockjdevteam/biolockj_controller:v1.4.2
This can be modified using the following properties:
Multiplexer.imageOwner
Multiplexer.imageName
Multiplexer.imageTag
Citation#
Module developed by Mike Sioda
BioLockJ v1.4.2