upstream/sam2interval/sam2interval.xml
1<tool id="sam2interval" name="Convert SAM" version="1.0.2" profile="16.04">
2 <description>to interval</description>
3 <requirements>
4 <requirement type="package" version="3.7">python</requirement>
5 </requirements>
6 <command>
7 python '$__tool_directory__/sam2interval.py' --input_sam_file='$input1' $print_all > '$out_file1'
8 </command>
9 <inputs>
10 <param format="sam" name="input1" type="data" label="Select dataset to convert"/>
11 <param name="print_all" type="select" label="Print all?" help="Do you want to retain original SAM fields? See example below.">
12 <option value="-p">Yes</option>
13 <option value="">No</option>
14 </param>
15 </inputs>
16 <outputs>
17 <data format="interval" name="out_file1" label="Converted Interval" />
18 </outputs>
19<tests>
20 <test>
21 <param name="input1" value="sam_bioinf_example.sam" ftype="sam"/>
22 <param name="print_all" value="Yes"/>
23 <output name="out_file1" file="sam2interval_printAll.dat" ftype="interval"/>
24 </test>
25 <test>
26 <param name="input1" value="sam_bioinf_example.sam" ftype="sam"/>
27 <param name="print_all" value="No"/>
28 <output name="out_file1" file="sam2interval_noprintAll.dat" ftype="interval"/>
29 </test>
30 <test>
31 <param name="input1" value="sam2interval-test3.sam" ftype="sam"/>
32 <param name="print_all" value="No"/>
33 <output name="out_file1" file="sam2interval_with_unmapped_reads_noprintAll.dat" ftype="interval"/>
34 </test>
35
36</tests>
37 <help>
38
39**What it does**
40
41Converts positional information from a SAM dataset into interval format with 0-based start and 1-based end. CIGAR string of SAM format is used to compute the end coordinate.
42
43-----
44
45**Example**
46
47Converting the following dataset::
48
49 r001 163 ref 7 30 8M2I4M1D3M = 37 39 TTAGATAAAGGATACTA *
50 r002 0 ref 9 30 3S6M1P1I4M * 0 0 AAAAGATAAGGATA *
51 r003 0 ref 9 30 5H6M * 0 0 AGCTAA * NM:i:1
52 r004 0 ref 16 30 6M14N5M * 0 0 ATAGCTTCAGC *
53 r003 16 ref 29 30 6H5M * 0 0 TAGGC * NM:i:0
54 r001 83 ref 37 30 9M = 7 -39 CAGCGCCAT *
55
56into Interval format will produce the following if *Print all?* is set to **Yes**::
57
58 ref 6 22 + r001 163 ref 7 30 8M2I4M1D3M = 37 39 TTAGATAAAGGATACTA *
59 ref 8 19 + r002 0 ref 9 30 3S6M1P1I4M * 0 0 AAAAGATAAGGATA *
60 ref 8 14 + r003 0 ref 9 30 5H6M * 0 0 AGCTAA * NM:i:1
61 ref 15 40 + r004 0 ref 16 30 6M14N5M * 0 0 ATAGCTTCAGC *
62 ref 28 33 - r003 16 ref 29 30 6H5M * 0 0 TAGGC * NM:i:0
63 ref 36 45 - r001 83 ref 37 30 9M = 7 -39 CAGCGCCAT *
64
65Setting *Print all?* to **No** will generate the following::
66
67 ref 6 22 + r001
68 ref 8 19 + r002
69 ref 8 14 + r003
70 ref 15 40 + r004
71 ref 28 33 - r003
72 ref 36 45 - r001
73
74
75 </help>
76</tool>