annotate kwip.xml @ 25:b2b1992502a6 draft default tip

planemo upload
author jowong
date Mon, 26 Nov 2018 02:56:53 -0500
parents 52a678a163ef
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25
b2b1992502a6 planemo upload
jowong
parents: 24
diff changeset
1 <tool id="kwip" name="kwip" version="1.3.1">
7
1850de9baad0 planemo upload
jowong
parents: 6
diff changeset
2 <description>Calculates k-mer weighted inner product, a de novo estimator of genetic similarity</description>
0
39519109479f planemo upload
jowong
parents:
diff changeset
3 <requirements>
39519109479f planemo upload
jowong
parents:
diff changeset
4 <requirement type="package" version="0.2.0">kwip</requirement>
39519109479f planemo upload
jowong
parents:
diff changeset
5 </requirements>
17
f4f6cbe16e5f planemo upload
jowong
parents: 16
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
19
49cd42efcb51 planemo upload
jowong
parents: 18
diff changeset
7 #for $input in $inputs# cp $input $(input.element_identifier).ct.gz && #end for#
11
a1dbbc803160 planemo upload
jowong
parents: 10
diff changeset
8 kwip
a1dbbc803160 planemo upload
jowong
parents: 10
diff changeset
9 -t $advanced.thread
a1dbbc803160 planemo upload
jowong
parents: 10
diff changeset
10 -k kwip.kernel
a1dbbc803160 planemo upload
jowong
parents: 10
diff changeset
11 -d kwip.dist
19
49cd42efcb51 planemo upload
jowong
parents: 18
diff changeset
12 #for $input in $inputs# $(input.element_identifier).ct.gz #end for#
20
034c1cec77f3 planemo upload
jowong
parents: 19
diff changeset
13 #for $input in $inputs# && rm $(input.element_identifier).ct.gz #end for#
0
39519109479f planemo upload
jowong
parents:
diff changeset
14 ]]></command>
39519109479f planemo upload
jowong
parents:
diff changeset
15 <inputs>
25
b2b1992502a6 planemo upload
jowong
parents: 24
diff changeset
16 <param name="inputs" format="data" type="data_collection" label="inputs" help="Specify dataset with hashed reads"/>
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
17 <section name="advanced" title="Advanced options" expanded="false">
2
80d123aa88b1 planemo upload
jowong
parents: 1
diff changeset
18 <param type="boolean" argument="--unweighted" label="Unweighted Inner Product" checked="false" truevalue="--unweighted" falsevalue="" help="Use the unweighted inner proudct kernel. (default: False)"/>
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
19 <param name="thread" type="integer" value="1" label="Threads" help="Number of simultaneous threads to execute (default: 1)" />
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
20
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
21 </section>
0
39519109479f planemo upload
jowong
parents:
diff changeset
22 </inputs>
39519109479f planemo upload
jowong
parents:
diff changeset
23 <outputs>
7
1850de9baad0 planemo upload
jowong
parents: 6
diff changeset
24 <data name="kwip_kernel" label="kWip kernel" format="txt" type="data" from_work_dir="kwip.kernel"/>
1850de9baad0 planemo upload
jowong
parents: 6
diff changeset
25 <data name="kwip_distance" label="kWip distance" format="txt" type="data" from_work_dir="kwip.dist"/>
0
39519109479f planemo upload
jowong
parents:
diff changeset
26 </outputs>
39519109479f planemo upload
jowong
parents:
diff changeset
27 <tests>
39519109479f planemo upload
jowong
parents:
diff changeset
28 </tests>
39519109479f planemo upload
jowong
parents:
diff changeset
29 <help><![CDATA[
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
30 usage: USAGE: kwip [options] hashes
0
39519109479f planemo upload
jowong
parents:
diff changeset
31
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
32 kWip Options.
0
39519109479f planemo upload
jowong
parents:
diff changeset
33
39519109479f planemo upload
jowong
parents:
diff changeset
34 optional arguments:
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
35 -t, --threads Number of threads to utilise. [default N_CPUS]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
36 -k, --kernel Output file for the kernel matrix. [default None]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
37 -d, --distance Output file for the distance matrix. [default stdout]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
38 -U, --unweighted Use the unweighted inner proudct kernel. [default off]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
39 -w, --weights Bin weight vector file (input, or output w/ -C).
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
40 -C, --calc-weights Calculate only the bin weight vector, not kernel matrix.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
41 -h, --help Print this help message.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
42 -V, --version Print the version string.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
43 -v, --verbose Increase verbosity. May or may not acutally do anything.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
44 -q, --quiet Execute silently but for errors.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
45
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
46 Each sample's oxli Countgraph should be specified after arguments:
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
47 kwip [options] sample1.ct sample2.ct ... sampleN.ct
0
39519109479f planemo upload
jowong
parents:
diff changeset
48
39519109479f planemo upload
jowong
parents:
diff changeset
49 ]]></help>
39519109479f planemo upload
jowong
parents:
diff changeset
50 <citations>
39519109479f planemo upload
jowong
parents:
diff changeset
51 <citation type="bibtex">
39519109479f planemo upload
jowong
parents:
diff changeset
52 @misc{githubPythonPRINCE,
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
53 author = {Murray, Kevin},
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
54 year = {2015},
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
55 title = {kWIP},
0
39519109479f planemo upload
jowong
parents:
diff changeset
56 publisher = {GitHub},
39519109479f planemo upload
jowong
parents:
diff changeset
57 journal = {GitHub repository},
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
58 url = {https://github.com/kdmurray91/kWIPE},
0
39519109479f planemo upload
jowong
parents:
diff changeset
59 }</citation>
39519109479f planemo upload
jowong
parents:
diff changeset
60 </citations>
39519109479f planemo upload
jowong
parents:
diff changeset
61 </tool>