annotate galaxy_stubs/FingerprintSimilaritySearch.xml @ 2:605370bc1def draft default tip

Uploaded
author luis
date Tue, 12 Jul 2016 12:33:33 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
605370bc1def Uploaded
luis
parents:
diff changeset
1 <?xml version='1.0' encoding='UTF-8'?>
605370bc1def Uploaded
luis
parents:
diff changeset
2 <!--This is a configuration file for the integration of a tools into Galaxy (https://galaxyproject.org/). This file was automatically generated using CTD2Galaxy.-->
605370bc1def Uploaded
luis
parents:
diff changeset
3 <!--Proposed Tool Section: [Chemoinformatics]-->
605370bc1def Uploaded
luis
parents:
diff changeset
4 <tool id="FingerprintSimilaritySearch" name="FingerprintSimilaritySearch" version="1.1.0">
605370bc1def Uploaded
luis
parents:
diff changeset
5 <description>calculate similar molecules in a library</description>
605370bc1def Uploaded
luis
parents:
diff changeset
6 <macros>
605370bc1def Uploaded
luis
parents:
diff changeset
7 <token name="@EXECUTABLE@">FingerprintSimilaritySearch</token>
605370bc1def Uploaded
luis
parents:
diff changeset
8 <import>macros.xml</import>
605370bc1def Uploaded
luis
parents:
diff changeset
9 </macros>
605370bc1def Uploaded
luis
parents:
diff changeset
10 <expand macro="stdio"/>
605370bc1def Uploaded
luis
parents:
diff changeset
11 <expand macro="requirements"/>
605370bc1def Uploaded
luis
parents:
diff changeset
12 <command>FingerprintSimilaritySearch
605370bc1def Uploaded
luis
parents:
diff changeset
13
605370bc1def Uploaded
luis
parents:
diff changeset
14 #if $param_t:
605370bc1def Uploaded
luis
parents:
diff changeset
15 -t $param_t
605370bc1def Uploaded
luis
parents:
diff changeset
16 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
17 #if $param_q:
605370bc1def Uploaded
luis
parents:
diff changeset
18 -q $param_q
605370bc1def Uploaded
luis
parents:
diff changeset
19 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
20 #if $param_o:
605370bc1def Uploaded
luis
parents:
diff changeset
21 -o $param_o
605370bc1def Uploaded
luis
parents:
diff changeset
22 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
23 #if $param_f:
605370bc1def Uploaded
luis
parents:
diff changeset
24 -f $param_f
605370bc1def Uploaded
luis
parents:
diff changeset
25 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
26 #if $param_fp_col:
605370bc1def Uploaded
luis
parents:
diff changeset
27 -fp_col $param_fp_col
605370bc1def Uploaded
luis
parents:
diff changeset
28 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
29 #if $param_id_col:
605370bc1def Uploaded
luis
parents:
diff changeset
30 -id_col $param_id_col
605370bc1def Uploaded
luis
parents:
diff changeset
31 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
32 #if $param_fp_tag:
605370bc1def Uploaded
luis
parents:
diff changeset
33 -fp_tag "$param_fp_tag"
605370bc1def Uploaded
luis
parents:
diff changeset
34 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
35 #if $param_id_tag:
605370bc1def Uploaded
luis
parents:
diff changeset
36 -id_tag "$param_id_tag"
605370bc1def Uploaded
luis
parents:
diff changeset
37 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
38 #if $param_tc:
605370bc1def Uploaded
luis
parents:
diff changeset
39 -tc $param_tc
605370bc1def Uploaded
luis
parents:
diff changeset
40 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
41 #if $param_nt:
605370bc1def Uploaded
luis
parents:
diff changeset
42 -nt "$param_nt"
605370bc1def Uploaded
luis
parents:
diff changeset
43 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
44 #if $param_bs:
605370bc1def Uploaded
luis
parents:
diff changeset
45 -bs $param_bs
605370bc1def Uploaded
luis
parents:
diff changeset
46 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
47 #if $param_sdf_out:
605370bc1def Uploaded
luis
parents:
diff changeset
48 -sdf_out $param_sdf_out
605370bc1def Uploaded
luis
parents:
diff changeset
49 #end if
605370bc1def Uploaded
luis
parents:
diff changeset
50 </command>
605370bc1def Uploaded
luis
parents:
diff changeset
51 <inputs>
605370bc1def Uploaded
luis
parents:
diff changeset
52 <param name="param_t" type="data" format="smi.gz,csv,sdf.gz,sdf,txt.gz,smi,txt,csv.gz" optional="False" value="&lt;class 'CTDopts.CTDopts._Null'&gt;" label="Target library input file" help="(-t) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
53 <param name="param_q" type="data" format="smi.gz,csv,sdf.gz,sdf,txt.gz,smi,txt,csv.gz" optional="False" value="&lt;class 'CTDopts.CTDopts._Null'&gt;" label="Query library input file" help="(-q) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
54 <param name="param_f" type="integer" min="1" max="2" optional="False" value="0" label="Fingerprint format [1 = binary bitstring, 2 = comma separated feature list]" help="(-f) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
55 <param name="param_fp_col" type="integer" value="-1" label="Column number for comma separated smiles input which contains the fingerprint" help="(-fp_col) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
56 <param name="param_id_col" type="integer" value="-1" label="Column number for comma separated smiles input which contains the molecule identifie" help="(-id_col) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
57 <param name="param_fp_tag" type="text" size="30" value=" " label="Tag name for SDF input which contains the fingerprint" help="(-fp_tag) ">
605370bc1def Uploaded
luis
parents:
diff changeset
58 <sanitizer>
605370bc1def Uploaded
luis
parents:
diff changeset
59 <valid initial="string.printable">
605370bc1def Uploaded
luis
parents:
diff changeset
60 <remove value="'"/>
605370bc1def Uploaded
luis
parents:
diff changeset
61 <remove value="&quot;"/>
605370bc1def Uploaded
luis
parents:
diff changeset
62 </valid>
605370bc1def Uploaded
luis
parents:
diff changeset
63 </sanitizer>
605370bc1def Uploaded
luis
parents:
diff changeset
64 </param>
605370bc1def Uploaded
luis
parents:
diff changeset
65 <param name="param_id_tag" type="text" size="30" value=" " label="Tag name for SDF input which contains the molecule identifie" help="(-id_tag) ">
605370bc1def Uploaded
luis
parents:
diff changeset
66 <sanitizer>
605370bc1def Uploaded
luis
parents:
diff changeset
67 <valid initial="string.printable">
605370bc1def Uploaded
luis
parents:
diff changeset
68 <remove value="'"/>
605370bc1def Uploaded
luis
parents:
diff changeset
69 <remove value="&quot;"/>
605370bc1def Uploaded
luis
parents:
diff changeset
70 </valid>
605370bc1def Uploaded
luis
parents:
diff changeset
71 </sanitizer>
605370bc1def Uploaded
luis
parents:
diff changeset
72 </param>
605370bc1def Uploaded
luis
parents:
diff changeset
73 <param name="param_tc" type="float" value="0.7" label="Tanimoto cutoff [default: 0.7]" help="(-tc) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
74 <param name="param_nt" type="text" size="30" value="1" label="Number of parallel threads to use" help="(-nt) To use all possible threads enter &lt;max&gt; [default: 1]">
605370bc1def Uploaded
luis
parents:
diff changeset
75 <sanitizer>
605370bc1def Uploaded
luis
parents:
diff changeset
76 <valid initial="string.printable">
605370bc1def Uploaded
luis
parents:
diff changeset
77 <remove value="'"/>
605370bc1def Uploaded
luis
parents:
diff changeset
78 <remove value="&quot;"/>
605370bc1def Uploaded
luis
parents:
diff changeset
79 </valid>
605370bc1def Uploaded
luis
parents:
diff changeset
80 </sanitizer>
605370bc1def Uploaded
luis
parents:
diff changeset
81 </param>
605370bc1def Uploaded
luis
parents:
diff changeset
82 <param name="param_bs" type="integer" value="500" label="Block size [default: 500]" help="(-bs) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
83 <param name="param_sdf_out" type="integer" min="0" max="1" optional="True" value="0" label="If query file has SD format, this flag activates writing of nearest neighbours as a new CSV tag in a copy of the query SD file" help="(-sdf_out) "/>
605370bc1def Uploaded
luis
parents:
diff changeset
84 </inputs>
605370bc1def Uploaded
luis
parents:
diff changeset
85 <expand macro="advanced_options"/>
605370bc1def Uploaded
luis
parents:
diff changeset
86 <outputs>
605370bc1def Uploaded
luis
parents:
diff changeset
87 <data name="param_o" metadata_source="param_t" format="input"/>
605370bc1def Uploaded
luis
parents:
diff changeset
88 </outputs>
605370bc1def Uploaded
luis
parents:
diff changeset
89 <help>This tool calculates all nearest neighbours above a similarity cutoff for given query molecules in a compound library on the basis of 2D binary fingerprints.
605370bc1def Uploaded
luis
parents:
diff changeset
90 The first library to specify (i1) is the compound library to be searched, the second library (i2) is conseiderd as the query compounds.
605370bc1def Uploaded
luis
parents:
diff changeset
91 Both files have to be comma separated values (csv) files and the binary fingerprints have to be encoded as feature lists or as binary bit strings.
605370bc1def Uploaded
luis
parents:
diff changeset
92
605370bc1def Uploaded
luis
parents:
diff changeset
93 WARNING: If similarity cutoff is chosen to be 0.0, the output will be the entire similarity matrix and has a size of n*m with n=|i1| and m=|i2|.
605370bc1def Uploaded
luis
parents:
diff changeset
94
605370bc1def Uploaded
luis
parents:
diff changeset
95 ======================================================================================================================================================
605370bc1def Uploaded
luis
parents:
diff changeset
96
605370bc1def Uploaded
luis
parents:
diff changeset
97 Examples:
605370bc1def Uploaded
luis
parents:
diff changeset
98
605370bc1def Uploaded
luis
parents:
diff changeset
99 $ FingerprintSimilaritySearch -t target.sdf -q query.sdf -o results -fp_tag FPRINT -f 1 -id_tag NAME
605370bc1def Uploaded
luis
parents:
diff changeset
100 tries to extract fingerprints as binary bitstrings (-f 1) from tag &lt;FPRINT&gt; and compound IDs from tag &lt;NAME&gt; of target.sdf and query.sdf.
605370bc1def Uploaded
luis
parents:
diff changeset
101 A similarity search is performed for all query molecules against all target molecules and pairs with similarity above Tanimoto cutoff 0.7 are written to outfile (results).
605370bc1def Uploaded
luis
parents:
diff changeset
102
605370bc1def Uploaded
luis
parents:
diff changeset
103 $ FingerprintSimilaritySearch -t target.sdf -q query.sdf -o results -fp_tag FPRINT -f 1 -id_tag NAME -sdf_out
605370bc1def Uploaded
luis
parents:
diff changeset
104 tries to extract fingerprints as binary bitstrings (-f 1) from tag &lt;FPRINT&gt; and compound IDs from tag &lt;NAME&gt; of target.sdf and query.sdf.
605370bc1def Uploaded
luis
parents:
diff changeset
105 A similarity search is performed for all query molecules against all target molecules and pairs with similarity above Tanimoto cutoff 0.7
605370bc1def Uploaded
luis
parents:
diff changeset
106 are added as a new SD tag to output file 'NN_TAGGED_query.sdf' as a list of TargetID:Similarity pairs.
605370bc1def Uploaded
luis
parents:
diff changeset
107
605370bc1def Uploaded
luis
parents:
diff changeset
108 $ FingerprintSimilaritySearch -t target.sdf -q query.smi -o results -fp_tag FPRINT -f 1 -id_tag NAME -fp_col 2
605370bc1def Uploaded
luis
parents:
diff changeset
109 tries to extract fingerprints as binary bitstrings (-f 1) from tag &lt;FPRINT&gt; and compound IDs from tag &lt;NAME&gt; of target.sdf
605370bc1def Uploaded
luis
parents:
diff changeset
110 and fingerprints as binary bitstrings of space separated query file from column 2 (-fp_col 2).
605370bc1def Uploaded
luis
parents:
diff changeset
111 A similarity search is performed for all query molecules against all target molecules and pairs with similarity above Tanimoto cutoff 0.7 are written to outfile (results).
605370bc1def Uploaded
luis
parents:
diff changeset
112
605370bc1def Uploaded
luis
parents:
diff changeset
113 </help>
605370bc1def Uploaded
luis
parents:
diff changeset
114 </tool>