annotate bsmap_meth_caller.xml @ 15:fc7ffd15b17f draft

Uploaded
author eiriche
date Fri, 30 Nov 2012 09:15:14 -0500
parents 2fb3be685c17
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
1 <tool id="bsmap_meth_caller" name="BSMAP Methylation Caller">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
2 <requirements>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
3 <requirement type='package'>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
4 bsmap
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
5 </requirement>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
6 </requirements>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
7 <requirements>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
8 <requirement type='package'>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
9 samtools
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
10 </requirement>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
11 </requirements>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
12 <command interpreter="bash">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
13 bsmap_meth_caller.sh
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
14 input=$bsmap_sam
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
15 unique=$unique
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
16 properly=$properly
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
17 zero_meth = $zero_meth
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
18 rem_dup = $rem_dup
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
19 combine_cpg = $combine_cpg
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
20 trimN = $trimN
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
21 depth = $depth
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
22 output=$output
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
23 tempdir=$output.files_path
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
24 #if $refGenomeSource.genomeSource == "history":
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
25 ref="${refGenomeSource.myFile}"
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
26 #else
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
27 ref="${refGenomeSource.builtinFile.fields.path}"
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
28 #end if
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
29
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
30 </command>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
31 <inputs>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
32 <conditional name="refGenomeSource">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
33 <param name="genomeSource" type="select" label="Will you select a reference genome from your history or use a built-in reference?" help="Must be the same reference as used for the mapping">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
34 <option value="builtin">Use a built-in reference</option>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
35 <option value="history">Use one from the history</option>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
36 </param>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
37 <when value="builtin">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
38 <param name="builtinFile" type="select" label="Select the reference genome">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
39 <options from_data_table="bsmap_fasta">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
40 <filter type="sort_by" column="2" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
41 <validator type="no_options" message="No reference genomes are available" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
42 </options>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
43 </param>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
44 </when>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
45 <when value="history">
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
46 <param name="myFile" type="data" format="fasta" label="Select the reference genome" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
47 </when>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
48 </conditional>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
49
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
50 <param name="bsmap_sam" format="sam" type="data" label="BSMAP mapping output file" help="Must be in SAM format" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
51 <param name="unique" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Process only unique mappings/pairs" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
52 <param name="properly" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Process only properly paired mappings" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
53 <param name="zero_meth" type="boolean" truevalue="true" falsevalue="false" checked="True" label="report loci with zero methylation ratios" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
54 <param name="rem_dup" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Remove duplicated reads" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
55 <param name="combine_cpg" type="boolean" truevalue="true" falsevalue="false" checked="False" label="Combine CpG methylaion ratios on both strands" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
56 <param name="trimN" type="integer" value="2" label="Trim N fill-in nucleotides in DNA fragment end-repairing" help="This option is only for pair-end mapping. For RRBS, N could be detetmined by the distance between cuttings sites on forward and reverse strands. For WGBS, N is usually between 0~3" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
57 <param name="depth" type="integer" value="1" label="Minimum sequencing depth to report loci" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
58 </inputs>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
59 <outputs>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
60 <data name="output" format ="bed" label="BSMAP methylation output" />
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
61 </outputs>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
62 <help>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
63 **What it does**
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
64
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
65 This methylation caller parses the BSMAP SAM output file into bed format.
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
66
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
67
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
68 **Output format** ::
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
69
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
70
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
71 Column Description
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
72 ---------------------- --------------------------------------
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
73 1 chr chromosome
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
74 2 pos position
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
75 3 strand strand
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
76 4 context context (CHH,CHG,CpG)
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
77 5 coverage totally sequenced Cs at that position
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
78 6 methylated methylated Cs at that position
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
79 7 percentage methylated percentage of 6
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
80 </help>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
81 </tool>
2fb3be685c17 Uploaded
eiriche
parents:
diff changeset
82