annotate svdetect/BAM_preprocessingPairs.xml @ 5:af119bf658e8 draft

Uploaded
author scisjnu123
date Thu, 12 Sep 2019 12:38:04 -0400
parents abdb3ed0c740
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
1 <tool id="svdetect_preprocessing" name="BAM preprocessing">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
2
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
3 <description>to get abnormal pairs</description>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
4
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
5 <command interpreter="perl"> BAM_preprocessingPairs.pl -t '$readType' -p '$pairType' -n '$nbrePair' -s '$isizeMin' -S '$isizeMax' -f '$foldPair' -o $__new_file_path__/svdetect -b '$abBAM' -l '$log' -N $sample_name
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
6 #if $newBam.pairNormal=="yes"
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
7 -d -x '$normBAM'
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
8 #end if
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
9 '$inputBam'
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
10 </command>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
11
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
12 <inputs>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
13 <param name="sample_name" type="text" value="sample" label="Sample Name"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
14 <param name="inputBam" type="data" format="bam" label="BAM input file"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
15 <param name="readType" type="select" label="Read type">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
16 <option value="1">Illumina</option>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
17 <option value="0">SOLiD</option>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
18 </param>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
19 <param name="pairType" type="select" label="Library type">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
20 <option value="1">Paired-end</option>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
21 <option value="0">Mate-Pair</option>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
22 </param>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
23 <conditional name="newBam">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
24 <param name="pairNormal" type="select" label="Do you want an additional bam file listing concordant mapped pairs?" help="Dump normal pairs into a file sample_name.norm.bam/sam">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
25 <option value="no">No</option>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
26 <option value="yes">Yes</option>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
27 </param>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
28 <when value="yes">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
29 <!-- do nothing here -->
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
30 </when>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
31 <when value="no">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
32 <!-- do nothing here -->
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
33 </when>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
34 </conditional>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
35 <param name="nbrePair" value="1000000" type="integer" size="30" label="Number of pairs for calculating mu (µ) and sigma (σ) lengths"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
36 <param name="isizeMin" value="0" type="integer" size="30" label="Minimum value of ISIZE for calculating mu (µ) and sigma (σ) lengths"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
37 <param name="isizeMax" value="10000" type="integer" size="30" label="Maximum value of ISIZE for calculating mu (µ)and sigma( σ) lengths"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
38 <param name="foldPair" value="3" type="float" size="30" label="Minimal number of sigma (σ) fold for filtering pairs"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
39 </inputs>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
40
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
41 <outputs>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
42 <data format="bam" name="abBAM" label="${$sample_name}.ab.bam"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
43 <data format="txt" name="log" label="${$sample_name}.svdetect_preprocessing.log"/>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
44 <data format="bam" name="normBAM" label="${$sample_name}.norm.bam">
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
45 <filter>newBam['pairNormal'] == 'yes'</filter>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
46 </data>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
47 </outputs>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
48
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
49 <help>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
50
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
51 **What it does**
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
52
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
53 Bam_preprocessingPairs - Version 0.5
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
54
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
55 Preprocessing of mates to get anomalously mapped mate-pair/paired-end reads as input for SVDetect.
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
56
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
57 From all pairs mapped onto the reference genome, this script outputs abnormal pairs:
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
58
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
59 * mapped on two different chromosomes
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
60 * with an incorrect strand orientation and/or pair order
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
61 * with an insert size distance +- sigma threshold
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
62
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
63 into a file prefix.ab.bam/sam sorted by read names
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
64
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
65 -BAM/SAM File input format only.
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
66
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
67 SAMtools required for BAM files
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
68
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
69 -----
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
70
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
71 .. class:: infomark
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
72
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
73 Contact Bruno Zeitouni (svdetect@curie.fr) for any questions or concerns about the Galaxy implementation of SVDetect.
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
74
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
75 </help>
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
76
abdb3ed0c740 Uploaded
scisjnu123
parents:
diff changeset
77 </tool>