annotate kwip.xml @ 10:1c03467f2267 draft

planemo upload
author jowong
date Thu, 22 Nov 2018 08:25:09 -0500
parents 9e7f04e98343
children a1dbbc803160
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
1c03467f2267 planemo upload
jowong
parents: 9
diff changeset
1 <tool id="kwip" name="kwip" version="1.1.9">
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>
39519109479f planemo upload
jowong
parents:
diff changeset
6 <command detect_errors="exit_code"><![CDATA[
10
1c03467f2267 planemo upload
jowong
parents: 9
diff changeset
7 kwip -h
0
39519109479f planemo upload
jowong
parents:
diff changeset
8 ]]></command>
39519109479f planemo upload
jowong
parents:
diff changeset
9 <inputs>
2
80d123aa88b1 planemo upload
jowong
parents: 1
diff changeset
10 <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
11 <section name="advanced" title="Advanced options" expanded="false">
2
80d123aa88b1 planemo upload
jowong
parents: 1
diff changeset
12 <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
13 <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
14
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
15 </section>
0
39519109479f planemo upload
jowong
parents:
diff changeset
16 </inputs>
39519109479f planemo upload
jowong
parents:
diff changeset
17 <outputs>
7
1850de9baad0 planemo upload
jowong
parents: 6
diff changeset
18 <data name="kwip_kernel" label="kWip kernel" format="txt" type="data" from_work_dir="kwip.kernel"/>
1850de9baad0 planemo upload
jowong
parents: 6
diff changeset
19 <data name="kwip_distance" label="kWip distance" format="txt" type="data" from_work_dir="kwip.dist"/>
0
39519109479f planemo upload
jowong
parents:
diff changeset
20 </outputs>
39519109479f planemo upload
jowong
parents:
diff changeset
21 <tests>
39519109479f planemo upload
jowong
parents:
diff changeset
22 </tests>
39519109479f planemo upload
jowong
parents:
diff changeset
23 <help><![CDATA[
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
24 usage: USAGE: kwip [options] hashes
0
39519109479f planemo upload
jowong
parents:
diff changeset
25
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
26 kWip Options.
0
39519109479f planemo upload
jowong
parents:
diff changeset
27
39519109479f planemo upload
jowong
parents:
diff changeset
28 optional arguments:
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
29 -t, --threads Number of threads to utilise. [default N_CPUS]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
30 -k, --kernel Output file for the kernel matrix. [default None]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
31 -d, --distance Output file for the distance matrix. [default stdout]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
32 -U, --unweighted Use the unweighted inner proudct kernel. [default off]
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
33 -w, --weights Bin weight vector file (input, or output w/ -C).
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
34 -C, --calc-weights Calculate only the bin weight vector, not kernel matrix.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
35 -h, --help Print this help message.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
36 -V, --version Print the version string.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
37 -v, --verbose Increase verbosity. May or may not acutally do anything.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
38 -q, --quiet Execute silently but for errors.
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
39
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
40 Each sample's oxli Countgraph should be specified after arguments:
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
41 kwip [options] sample1.ct sample2.ct ... sampleN.ct
0
39519109479f planemo upload
jowong
parents:
diff changeset
42
39519109479f planemo upload
jowong
parents:
diff changeset
43 ]]></help>
39519109479f planemo upload
jowong
parents:
diff changeset
44 <citations>
39519109479f planemo upload
jowong
parents:
diff changeset
45 <citation type="bibtex">
39519109479f planemo upload
jowong
parents:
diff changeset
46 @misc{githubPythonPRINCE,
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
47 author = {Murray, Kevin},
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
48 year = {2015},
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
49 title = {kWIP},
0
39519109479f planemo upload
jowong
parents:
diff changeset
50 publisher = {GitHub},
39519109479f planemo upload
jowong
parents:
diff changeset
51 journal = {GitHub repository},
1
66d91eade17a planemo upload
jowong
parents: 0
diff changeset
52 url = {https://github.com/kdmurray91/kWIPE},
0
39519109479f planemo upload
jowong
parents:
diff changeset
53 }</citation>
39519109479f planemo upload
jowong
parents:
diff changeset
54 </citations>
39519109479f planemo upload
jowong
parents:
diff changeset
55 </tool>