Quick User Manual
- Input files naming convention
- Launching an Analysis
- Creating pipeline
- Providing an order
- Sending soft options
- Output results
- Output and error LOGS
TOGGLE will automatically assign sample name (readgroup) based on the input file name structure, picking up the “text” before the first dot.
- individual1_1.fastq will be understood as individual1
- mapping1.sam will be understood as mapping1
- myVcf.complete.vcf will be understood as myVcf
For Fastq files, only one underscore (‘_’) is allowed, before the direction of sequences ( _1, _2 or _R1, _R2), just before the extension (.fastq).
Please use only UTF-8 standard symbols, no weird characters or space, pipe, tilde or any type of commas.
The current version is based on the toggleGenerator.pl script
|Required named arguments:|
|-d / –directory DIR:||a folder with raw data to be treated (FASTQ, FASTQ.GZ, SAM, BAM, VCF)|
|-c / –config FILE:||generally it is the software.config.txt file but it can be any text file structured as shown below.|
|-o / –outputdir DIR:||the current version of TOGGLE will not modify the initial data folder but will create an output directory with all analyses in.|
|Optional named arguments:|
|-r / –reference FILE:||the reference FASTA file to be used. (1)|
|-g / -gff FILE:||the GFF file to be used for some tools.|
|-k / –keyfile FILE:||the keyfile use for demultiplexing step.|
|-nocheck / –nocheckFastq:||by default toggle checks if fastq format is correct in every file. This option allows to skip this step.|
|-report / –report:||generate pdf report (more info)|
|-h / –help:||show help message and exit|
(1): If no index exists it will be created accordingly to the pipeline requested index. If the index exist, they will not be re-created UNLESS the pipeline order (see below) expressively requests it (updating the index e.g.)
All the the paths (files and folders) can be provided as absolute (/home/mylogin/data/myRef.fasta) or relative (../data/myRef.fasta).
so for exemple command is:
The SNPdiscoveryPaired.config.txt file is an example of how to customize your pipeline.
The order of a pipeline is provided with key $order
Then add all software configuration using key $softName and after options such below:
TOGGLE will generate an output folder containing different files and subfolders, as follows:
The final results are contained in the finalResults folder. TOGGLE will also copy the software config file corresponding to the analysis, in order users can recover their options. The output folder contains all sub analyses, i.e. the individual analyses or intermediate data.
TOGGLE will generate two main types of logs, the .o for normal output and the .e for the errors and warnings (these last ones are normally empty files). Each level of TOGGLE will generate this pair of log: * GLOBAL_ANALYSIS_date.o/.e logs represent the general output for the complete analysis (toggleGenerator.pl logs). They are located at the root of the output directory. * IndividualName_global_log.o/.e logs represent the local output for sub analysis (toggleBzz.pl and toggleMultiple.pl logs). They are located in their respective subdirectories in the output folder.