annotate bsmap_meth_caller.xml @ 28:781b796c6b9c draft

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