annotate misp.xml @ 0:87f7630ab82f draft default tip

Imported from capsule None
author jjohnson
date Thu, 25 Sep 2014 14:05:16 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
1 <tool name="MISP: Motif-based Interval Screener with PSSM" id="misp" version="0.1.0">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
2 <description>Input one or more motifs, find all hits in peak regions</description>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
3 <requirements>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
4 <requirement type="package" version="2013-11-28">misp</requirement>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
5 <requirement type="package" version="2.19.1">bedtools</requirement>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
6 </requirements>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
7 <command>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
8 #if $motifopt.motifopt_select == "upload"
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
9 #set $motif_db = str($motifopt.motif_file)
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
10 #else
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
11 #set $motif_db = "\${MISP_DATABASE_PATH}/motif/cistrome.db"
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
12 #end if
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
13 #set $motif_id = str($motifopt.motif_id)
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
14 #if $refGenomeSource.genomeSource == "history":
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
15 #set $genome_file = $refGenomeSource.ownFile
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
16 #else:
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
17 #set $genome_file = $refGenomeSource.index.fields.path
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
18 #end if
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
19 bedtools getfasta -fi $genome_file -bed $bedfile -fo out.fasta > /dev/null &amp;&amp;
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
20 misp out.fasta $motif_db $pvalue $motif_id output &amp;> $log &amp;&amp;
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
21 cat output* > $outputtxt
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
22 </command>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
23 <stdio>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
24 <exit_code range="1:" level="fatal" description="Error" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
25 </stdio>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
26 <inputs>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
27 <param format="bed" name="bedfile" type="data" label="bed file for regions">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
28 <validator type="unspecified_build" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
29 </param>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
30 <conditional name="refGenomeSource">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
31 <param name="genomeSource" type="select" label="Use a built in reference genome or own from your history" help="Built-ins genomes were created using default options">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
32 <option value="cached" selected="True">Use a built-in genome</option>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
33 <option value="history">Use a genome from history</option>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
34 </param>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
35 <when value="cached">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
36 <param name="index" type="select" label="Select a reference genome" help="If your genome of interest is not listed, contact the Galaxy team">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
37 <options from_data_table="all_fasta">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
38 <filter type="data_meta" ref="bedfile" key="dbkey" column="1" multiple="True" separator="," />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
39 <validator type="no_options" message="No reference build available for selected input" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
40 </options>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
41 </param>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
42 </when>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
43 <when value="history">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
44 <param name="ownFile" type="data" format="fasta" metadata_name="dbkey" label="Select the reference genome" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
45 </when> <!-- history -->
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
46 </conditional> <!-- refGenomeSource -->
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
47 <conditional name="motifopt">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
48 <param name="motifopt_select" type="select" label="upload a motif or select from our database.">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
49 <option value="upload">Use uploaded motif</option>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
50 <option value="database">Use motif in cistrome database.</option>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
51 </param>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
52 <when value="upload">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
53 <param name="motif_file" type="data" label="motif file" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
54 <param name="motif_id" type="text" label="The motif id in uploaded motif file. Or write 'all' to run all motifs in the file." />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
55 </when>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
56 <when value="database">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
57 <param name="motif_id" type="text" label="The motif id in Cistrome motif collection. Or write 'all' to run all motifs in the file." />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
58 </when>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
59 </conditional>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
60 <param name="pvalue" type="float" label="p-value cutoff for the motif screen" value="0.001">
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
61 <validator type="in_range" max="1" min="0" message="pvalue is out of range, width has to be between 0 to 1" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
62 </param>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
63 </inputs>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
64 <outputs>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
65 <data format="txt" name="outputtxt" label="MISP hits on ${bedfile.name}"/>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
66 <data format="txt" name="log" label="Log of MISP on ${bedfile.name}"/>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
67 </outputs>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
68 <tests>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
69 <test>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
70 <param name="bedfile" type="bed" value="test.bed" dbkey="mm9"/>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
71 <param name="genomeSource" value="history" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
72 <param name="ownFile" type="fasta" value="mm9_chr19_part.fasta" dbkey="mm9"/>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
73 <param name="motifopt_select" value="upload" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
74 <param name="motif_file" value="misp_motif" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
75 <param name="motif_id" value="M00139" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
76 <param name="pvalue" value="0.001" />
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
77 <output name="outputtxt" file="misp.hits"/>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
78 <output name="log" file="misp.log"/>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
79 </test>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
80 </tests>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
81 <help>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
82 Given a motif, this tool will find all hits of the motif in specified region.
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
83
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
84 -----
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
85
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
86 **Formula**
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
87
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
88 .. image:: ./static/cistrome_icons/misp_formula.png
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
89
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
90 -----
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
91
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
92 **TIP:** The source code of misp is available at bitbucket_
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
93
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
94 .. _bitbucket: https://bitbucket.org/hanfeisun/misp/overview
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
95
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
96
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
97 **TIP:** To check the motif id in our database, click here_
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
98
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
99 .. _here: http://cistrome.org/motif/
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
100
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
101 -----
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
102
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
103 Left to right shoule be:
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
104
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
105 T
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
106
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
107 C
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
108
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
109 G
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
110
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
111 A
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
112
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
113 **Example of the format of uploaded motif database.**
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
114
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
115 M00139
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
116
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
117 0.667 0.111 0.667 0.01 0.01 0.01 0.01 0.01 0.333 0.01 0.01 0.333 0.444 0.222 0.01 0.01 0.01 0.01
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
118
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
119 0.01 0.546 0.111 0.97 0.01 0.97 0.01 0.97 0.111 0.01 0.444 0.444 0.536 0.333 0.222 0.111 0.01 0.222
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
120
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
121 0.01 0.333 0.111 0.01 0.01 0.01 0.97 0.01 0.222 0.01 0.536 0.111 0.01 0.333 0.758 0.556 0.667 0.667
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
122
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
123 0.313 0.01 0.111 0.01 0.97 0.01 0.01 0.01 0.334 0.97 0.01 0.112 0.01 0.112 0.01 0.323 0.313 0.101
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
124
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
125 hPDI060
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
126
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
127 0.01 0.01 0.01 0.625 0.01 0.01
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
128
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
129 0.97 0.97 0.97 0.01 0.5 0.97
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
130
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
131 0.01 0.01 0.01 0.01 0.48 0.01
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
132
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
133 0.01 0.01 0.01 0.355 0.01 0.01
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
134 </help>
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
135
87f7630ab82f Imported from capsule None
jjohnson
parents:
diff changeset
136 </tool>