annotate mash_screen.xml @ 2:7f7d8b0c8517 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
author iuc
date Sun, 16 Feb 2020 17:03:45 -0500
parents 402b67d1af7d
children f8e51626fc56
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
1 <tool id="mash_screen" name="mash screen" version="@TOOL_VERSION@+galaxy2" profile="19.01">
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
2 <description>determines how well query sequences are contained within a pool of sequences</description>
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
3 <macros>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
4 <import>macros.xml</import>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
5 </macros>
2
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
6 <expand macro="requirements" />
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
7 <expand macro="version_command" />
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
9 ln -s '$queries' queries.msh &&
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
10 mash screen
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
11 $winner_takes_all
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
12 -i $minimum_identity_to_report
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
13 -v $maximum_p_value_to_report
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
14 queries.msh
1
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
15 #if str( $pool_input.pool_input_selector ) == "paired"
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
16 '$pool_input.pool_1' '$pool_input.pool_2'
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
17 #end if
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
18 #if str( $pool_input.pool_input_selector ) == "paired_collection"
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
19 '$pool_input.pool.forward' '$pool_input.pool.reverse'
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
20 #end if
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
21 #if str( $pool_input.pool_input_selector ) == "single"
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
22 '$pool_input.pool'
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
23 #end if
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
24 > '$output'
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
25 ]]></command>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
26 <inputs>
1
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
27 <conditional name="pool_input">
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
28 <param name="pool_input_selector" type="select" label="Single or Paired-end reads" help="Select between paired and single end data">
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
29 <option value="paired">Paired</option>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
30 <option value="single">Single</option>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
31 <option value="paired_collection">Paired Collection</option>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
32 </param>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
33 <when value="paired">
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
34 <param name="pool_1" type="data" format="@INTYPES@" label="Select first set of reads" help="Specify dataset with forward reads"/>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
35 <param name="pool_2" type="data" format="@INTYPES@" label="Select second set of reads" help="Specify dataset with reverse reads"/>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
36 </when>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
37 <when value="single">
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
38 <param name="pool" type="data" format="@INTYPES@" label="Select fastq dataset" help="Specify dataset with single reads"/>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
39 </when>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
40 <when value="paired_collection">
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
41 <param name="pool" format="@INTYPES@" type="data_collection" collection_type="paired" label="Select a paired collection" help="See help section for an explanation of dataset collections"/>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
42 </when>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
43 </conditional>
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
44 <param name="queries" type="data" format="msh" />
2
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
45 <param name="winner_takes_all" argument="-w" type="boolean" checked="true" truevalue="-w" falsevalue="" label="'Winner takes all' to remove redundancy in the result"
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
46 help="If this option is not enabled, every matching strain from the same species of the reference database is reported in the result."/>
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
47 <param type="float" name="minimum_identity_to_report" argument="-i" value="0." min="-1." max="1." label="Minimum identity to report" />
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
48 <param type="float" name="maximum_p_value_to_report" argument="-v" value="1." min="0." max="1." label="Maximum p-value to report" />
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
49 </inputs>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
50 <outputs>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
51 <data name="output" format="tabular" />
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
52 </outputs>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
53 <tests>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
54 <test>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
55 <param name="queries" value="NZ_MYON01000010.1.msh"/>
1
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
56 <param name="pool_input_selector" value="single"/>
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
57 <param name="pool" value="ERR024951_seqtk_sample_1000_1.fastq"/>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
58 <output name="output" file="mash_screen_NZ_MYON01000010.1_ERR024951_seqtk_sample_1000_1.tsv"/>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
59 </test>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
60 <test>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
61 <param name="queries" value="NZ_MYON01000010.1.msh"/>
1
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
62 <param name="pool_input_selector" value="single"/>
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
63 <param name="pool" value="ERR024951_seqtk_sample_1000_2.fastq"/>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
64 <output name="output" file="mash_screen_NZ_MYON01000010.1_ERR024951_seqtk_sample_1000_2.tsv"/>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
65 </test>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
66 <test>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
67 <param name="queries" value="NZ_MYON01000010.1.msh"/>
1
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
68 <param name="pool_input_selector" value="paired"/>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
69 <param name="pool_1" value="ERR024951_seqtk_sample_1000_1.fastq"/>
402b67d1af7d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 91435d801528addac840722e9a0092b2d342b8bb
iuc
parents: 0
diff changeset
70 <param name="pool_2" value="ERR024951_seqtk_sample_1000_2.fastq"/>
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
71 <output name="output" file="mash_screen_NZ_MYON01000010.1_ERR024951_seqtk_sample_1000_1and2.tsv"/>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
72 </test>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
73 </tests>
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
74 <help><![CDATA[
2
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
75
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
76 **What it does**
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
77
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
78 Determine how well query sequences are contained within a pool of sequences.
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
79 The queries must be formatted as a single Mash sketch file (.msh), created
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
80 with the `mash sketch` command. The <pool> files can be contigs or reads, in
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
81 fasta or fastq, gzipped or not, and "-" can be given for <pool> to read from
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
82 standard input. The <pool> sequences are assumed to be nucleotides, and will
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
83 be 6-frame translated if the <queries> are amino acids. The output fields are
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
84 [identity, shared-hashes, median-multiplicity, p-value, query-ID,
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
85 query-comment], where median-multiplicity is computed for shared hashes, based
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
86 on the number of observations of those hashes within the pool.
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
87 ]]></help>
2
7f7d8b0c8517 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 24f4271bd62a3d96fec812eae2ad607f6a7f723c"
iuc
parents: 1
diff changeset
88 <expand macro="citations"/>
0
bac720dc1948 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mash commit 500478e8adcabf5249941012f78fe2140ecc7264
iuc
parents:
diff changeset
89 </tool>