annotate query.xml @ 19:7f712cc0d3d5 draft

Uploaded 20190304.2
author fabio
date Mon, 04 Mar 2019 08:31:28 -0500
parents
children 1dc3f0c61817
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
1 <?xml version="1.0"?>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
2 <tool name="BloomTree Manager - Query" id="btman_query" version="1.0.0">
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
3 <description>a Sequence Bloom Tree</description>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
4 <macros>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
5 <import>macros.xml</import>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
6 </macros>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
7 <expand macro="requirements" />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
8 <command detect_errors="exit_code">
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
9 <![CDATA[
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
10 python '$__tool_directory__/query.py'
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
11
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
12 #set coll_paths = ','.join( [ str( $f ) for $f in $treecollection ] )
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
13 #if $coll_paths is not 'None':
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
14 --treep '${coll_paths}'
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
15 #set coll_names = ','.join( [ str( $f.name ) for $f in $treecollection ] )
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
16 --treen '${coll_names}'
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
17 #end if
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
18
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
19 #set file_paths = ','.join( [ str( $f ) for $f in $txtfiles ] )
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
20 #if $file_paths is not 'None':
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
21 --files '${file_paths}'
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
22 #set file_names = ','.join( [ str( $f.name ) for $f in $txtfiles ] )
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
23 --names '${file_names}'
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
24 #end if
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
25
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
26 --threshold ${threshold}
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
27 --sort ${sort}
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
28
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
29 --outputdir 'answer_collection'
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
30 --outfile '${resulttxt}'
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
31 ]]>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
32 </command>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
33 <inputs>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
34 <param name="treecollection" type="data_collection" collection_type="list" label="Select a Sequence Bloom Tree" help="Select a collection generated by the Create tool of the BloomTree Manager suite." />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
35 <param format="tabular" name="txtfiles" type="data" label="Select query files" multiple="true" optional="false" help="Select one or more tabular files containing (ID, TRANSCRIPT) couples for each line. The content of these files will be merged and the result will represent a query to the Sequence Bloom Tree that will return a collection containing a file for each ID. The content of these files as result of the tool will be a list of accession numbers." />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
36 <param name="threshold" size="1" type="float" value="0.7" min="0.0" max="1.0" label="Search threshold" help="Fraction of query kmers that must be present in a leaf to be considered a match." />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
37 <param name="sort" type="boolean" checked="true" truevalue="1" falsevalue="0" label="Sort matched leaves by the number of query kmers present, and report the number of kmers present (if not selected we just report the matched leaves without regard to which matches are better)." />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
38 </inputs>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
39 <outputs>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
40 <collection name="output_collect" type="list:list" label="BloomTree Manager - Query result collection">
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
41 <discover_datasets pattern="(?P&lt;identifier_0&gt;[^_]+)_(?P&lt;identifier_1&gt;[^_]+)_(?P&lt;ext&gt;[^_]+)" directory="answer_collection" ext="auto" />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
42 </collection>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
43 <data format="txt" name="resulttxt" label="${tool.name} SBT: Result" from_work_dir="query.txt" />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
44 </outputs>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
45
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
46 <help><![CDATA[
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
47 This tool is part of the BloomTree Manager Framework that allow to rapidly identify all
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
48 sequenced samples which express a transcript of interest.
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
49
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
50 ----
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
51
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
52 The input for this tool is a list of (ID, TRANSCRIPT) couples, one for each line,
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
53 in a tab delimited format::
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
54
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
55 id0 CCAACCAAAGGGAAAACTTTTTTCCGACTTTGGCCTAAAGGGTTTAACGGCCAAGTCAGAAGGGAAAAAGTTGCGCCA
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
56 id1 TTAATGACAGGGCCACATGATGTGAAAAAAAATCAGAAACCGAGTCAACGTGAGAAGATAGTACGTACTACCGCAAAT
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
57 ...
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
58 idn CAATTAATGATAAATATTTTATAAGGTGCGGAAATAAAGTGAGGAATATCTTTTAAATTCAAGTTCAATTCTGAAAGC
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
59
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
60 The ID can contain alphanumeric characters in addition to spaces, dots, dashes, and round and square brackets.
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
61 Any additional character will be trimmed out.
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
62
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
63 The Sequence Bloom Tree identifier must be also specified. It is a string that identify an existing Sequence
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
64 Bloom Tree, which should be built with the Create tool of the BloomTree Manager Suite.
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
65
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
66 The output of the tool is a list of collections in which every collection contains a file for each ID with a list of
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
67 accession numbers representing the samples that express one particular transcript.
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
68
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
69 ----
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
70
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
71 .. class:: infomark
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
72
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
73 **Notes**
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
74
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
75 This Galaxy tool has been developed by Fabio Cumbo.
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
76
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
77 Please visit this GithHub_repository_ for more information about the BloomTree Manager
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
78
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
79 .. _GithHub_repository: https://github.com/fabio-cumbo/bloomtree-manager
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
80 ]]></help>
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
81
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
82 <expand macro="citations" />
7f712cc0d3d5 Uploaded 20190304.2
fabio
parents:
diff changeset
83 </tool>