|
0
|
1 <tool id="cshl_fastx_barcode_splitter" version="1.0.0" name="Barcode Splitter">
|
|
|
2 <description></description>
|
|
|
3 <requirements>
|
|
|
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
|
|
|
5 </requirements>
|
|
|
6 <command interpreter="bash">fastx_barcode_splitter_galaxy_wrapper.sh $BARCODE $input "$input.name" "$output.files_path" --mismatches $mismatches --partial $partial $EOL > $output </command>
|
|
|
7
|
|
|
8 <inputs>
|
|
|
9 <param format="txt" version="1.0.0" name="BARCODE" type="data" label="Barcodes to use" />
|
|
|
10 <param format="fasta,fastqsanger,fastqsolexa,fastqillumina" version="1.0.0" name="input" type="data" label="Library to split" />
|
|
|
11
|
|
|
12 <param version="1.0.0" name="EOL" type="select" label="Barcodes found at">
|
|
|
13 <option value="--bol">Start of sequence (5' end)</option>
|
|
|
14 <option value="--eol">End of sequence (3' end)</option>
|
|
|
15 </param>
|
|
|
16
|
|
|
17 <param version="1.0.0" name="mismatches" type="integer" size="3" value="2" label="Number of allowed mismatches" />
|
|
|
18
|
|
|
19 <param version="1.0.0" name="partial" type="integer" size="3" value="0" label="Number of allowed barcodes nucleotide deletions" />
|
|
|
20
|
|
|
21 </inputs>
|
|
|
22
|
|
|
23 <tests>
|
|
|
24 <test>
|
|
|
25 <!-- Split a FASTQ file -->
|
|
|
26 <param version="1.0.0" name="BARCODE" value="fastx_barcode_splitter1.txt" />
|
|
|
27 <param version="1.0.0" name="input" value="fastx_barcode_splitter1.fastq" ftype="fastqsolexa" />
|
|
|
28 <param version="1.0.0" name="EOL" value="Start of sequence (5' end)" />
|
|
|
29 <param version="1.0.0" name="mismatches" value="2" />
|
|
|
30 <param version="1.0.0" name="partial" value="0" />
|
|
|
31 <output version="1.0.0" name="output" file="fastx_barcode_splitter1.out" />
|
|
|
32 </test>
|
|
|
33 </tests>
|
|
|
34
|
|
|
35 <outputs>
|
|
|
36 <data format="html" version="1.0.0" name="output" />
|
|
|
37 </outputs>
|
|
|
38 <help>
|
|
|
39
|
|
|
40 **What it does**
|
|
|
41
|
|
|
42 This tool splits a Solexa library (FASTQ file) or a regular FASTA file into several files, using barcodes as the split criteria.
|
|
|
43
|
|
|
44 --------
|
|
|
45
|
|
|
46 **Barcode file Format**
|
|
|
47
|
|
|
48 Barcode files are simple text files.
|
|
|
49 Each line should contain an identifier (descriptive name for the barcode), and the barcode itself (A/C/G/T), separated by a TAB character.
|
|
|
50 Example::
|
|
|
51
|
|
|
52 #This line is a comment (starts with a 'number' sign)
|
|
|
53 BC1 GATCT
|
|
|
54 BC2 ATCGT
|
|
|
55 BC3 GTGAT
|
|
|
56 BC4 TGTCT
|
|
|
57
|
|
|
58 For each barcode, a new FASTQ file will be created (with the barcode's identifier as part of the file name).
|
|
|
59 Sequences matching the barcode will be stored in the appropriate file.
|
|
|
60
|
|
|
61 One additional FASTQ file will be created (the 'unmatched' file), where sequences not matching any barcode will be stored.
|
|
|
62
|
|
|
63 The output of this tool is an HTML file, displaying the split counts and the file locations.
|
|
|
64
|
|
|
65 **Output Example**
|
|
|
66
|
|
|
67 .. image:: ${static_path}/fastx_icons/barcode_splitter_output_example.png
|
|
|
68
|
|
|
69
|
|
|
70 ------
|
|
|
71
|
|
|
72 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
|
|
|
73
|
|
|
74 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
|
|
|
75
|
|
|
76 </help>
|
|
|
77 <!-- FASTX-barcode-splitter is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
|
|
|
78 </tool>
|
