annotate create.xml @ 16:ba9d0fc8657f draft

Uploaded 20190118
author fabio
date Fri, 18 Jan 2019 10:12:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
1 <?xml version="1.0"?>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
2 <tool name="BloomTree Manager - Create" id="btman_create" version="1.0.0">
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
3 <description>a Sequence Bloom Tree</description>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
4 <macros>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
5 <import>macros.xml</import>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
6 </macros>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
7 <expand macro="requirements" />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
8 <command detect_errors="exit_code">
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
9 <![CDATA[
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
10 python '$__tool_directory__/create.py'
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
11
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
12 --explist '${explist}'
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
13
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
14 --qualitycontrol ${conditional_quality.quality_control}
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
15 #if $conditional_quality.quality_control == '0':
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
16 --qualitythreshold 0.0
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
17 #elif $conditional_quality.quality_control == '1':
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
18 --qualitythreshold ${conditional_quality.quality_threshold}
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
19 #end if
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
20
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
21 --klen ${kmer_len}
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
22 --minabundance ${min_abundance}
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
23
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
24 --outfile '${outfile}'
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
25 ]]>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
26 </command>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
27 <inputs>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
28 <param format="tabular" name="explist" type="data" label="Select a file with the list of experiments" help="This should be a tabular file with two columns. Take a look at the tool documentation for a detailed explanation about the its content." />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
29
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
30 <conditional name="conditional_quality">
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
31 <param name="quality_control" type="boolean" checked="false" truevalue="1" falsevalue="0" label="Apply a quality control procedure" />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
32 <when value="1">
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
33 <param name="quality_threshold" size="1" type="float" value="0.8" min="0.0" max="1.0" label="Quality threshold" help="If the number of sequences flagged as poor quality on the total number of sequences in a file is less than this threshold, the sequence file will be excluded." />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
34 </when>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
35 </conditional>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
36
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
37 <param name="kmer_len" type="integer" value="21" min="0" label="K-mer length" />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
38 <param name="min_abundance" type="integer" value="2" min="0" label="Bloom filter minimum abundance" help="This value is the minimum abundance cutoff for the creation of the Bloom filters. It is worth noting that the same minimum abundance is used for each Bloom filter." />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
39 </inputs>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
40 <outputs>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
41 <data format="txt" name="outfile" label="${tool.name} SBT: Result" from_work_dir="btman.create.txt" />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
42 </outputs>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
43
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
44 <help><![CDATA[
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
45 This tool is part of the BloomTree Manager Framework that allow to create a Sequence Bloom Tree starting
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
46 with a set of FASTA or FASTQ files. It allows also to control the quality of the input dataset and
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
47 exclude the files that do not reach a specified quality level.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
48
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
49 -----
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
50
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
51 **Input file**
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
52
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
53 The input file for this tool must contain two columns with their values delimited by a tab.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
54 The first column contains a list of SRA accessions, and the second column contains a unique identifier
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
55 for each set of SRA accessions.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
56
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
57 The input file is structured like the example below::
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
58
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
59 SRR805782 blood
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
60 SRR837459 blood
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
61 SRR837458 blood
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
62 SRR837453 blood
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
63 SRR837456 blood
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
64 ...
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
65 SRR791048 breast
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
66 SRR553483 breast
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
67 SRR553482 breast
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
68 SRR791045 breast
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
69 ...
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
70 SRR950876 brain
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
71 SRR786621 brain
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
72
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
73 It is worth noting that for each cluster of accessions, every accession should be unique.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
74 It is indeed possible to repeat an accession in multiple clusters.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
75
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
76 The tool will create a Sequence Bloom Tree for each cluster of accessions.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
77
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
78 -----
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
79
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
80 **Output**
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
81
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
82 The tool returns a single text file only. It contains the a tree identifier, one for
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
83 each cluster of accessions specified in the input file, that can be used with the
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
84 Query tool of the BloomTree Manager Suite to search for the presence of a set of
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
85 specific transcripts.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
86
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
87 Take a look at the Query tool documentation for a detailed description about how
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
88 to query a Sequence Bloom Tree.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
89
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
90 -----
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
91
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
92 .. class:: infomark
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
93
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
94 **Notes**
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
95
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
96 This Galaxy tool has been developed by Fabio Cumbo.
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
97
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
98 Please visit this GithHub_repository_ for more information about the BloomTree Manager
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
99
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
100 .. _GithHub_repository: https://github.com/fabio-cumbo/bloomtree-manager
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
101 ]]></help>
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
102
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
103 <expand macro="citations" />
ba9d0fc8657f Uploaded 20190118
fabio
parents:
diff changeset
104 </tool>