annotate tradis_gene_insert_sites.xml @ 2:103bd59b3e33 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 6a29aaead9d6b0f69ef70113df58047877fc6ce5"
author iuc
date Wed, 04 Nov 2020 15:32:47 +0000
parents 58234d95978d
children 8e4a4f240961
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
58234d95978d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 61c83ac999a040604915ff7cf92670b2635b967e"
iuc
parents: 0
diff changeset
1 <tool id="tradis_gene_insert_sites" name="Bio-TraDis counts to gene insertion data" version="@TOOL_VERSION@+galaxy@VERSION@">
0
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
2 <description></description>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
3 <macros>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
4 <import>macros.xml</import>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
5 </macros>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
6 <expand macro="requirements" />
2
103bd59b3e33 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 6a29aaead9d6b0f69ef70113df58047877fc6ce5"
iuc
parents: 1
diff changeset
7 <command detect_errors="aggressive">
0
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
8 <![CDATA[
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
9 tradis_gene_insert_sites -trim3 '$trim3' -trim5 '$trim5' '$input_annot' '$input_counts'
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
10 ]]>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
11 </command>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
12
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
13 <inputs>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
14 <param name="input_counts" type="data" format="tabular" label="Read counts" help="Read counts at each nucleotide position for both strands. The first column contains forward strand counts, and the second contains reverse strand counts."/>
1
58234d95978d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 61c83ac999a040604915ff7cf92670b2635b967e"
iuc
parents: 0
diff changeset
15 <param name="input_annot" type="data" format="embl" label="EMBL file containing the reference genome annotations"/>
0
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
16 <param name="trim3" type="float" value="0.1" min="0" max="1" label="Portion of the gene to trim in 3' end'" help="Trim reads at the 3'end of genes. Some transposon insertions can be little disruptive when they occur end of genes. Trim to ignore these reads."/>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
17 <param name="trim5" type="float" value="0" min="0" max="1" label="Portion of the gene to trim" help="Trim reads at the 5'end of genes. Some transposon insertions can be little disruptive when they occur end of genes. Trim to ignore these reads."/>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
18
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
19 </inputs>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
20
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
21 <outputs>
1
58234d95978d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 61c83ac999a040604915ff7cf92670b2635b967e"
iuc
parents: 0
diff changeset
22 <data name="gene_insert_sites" format="csv" from_work_dir="./*.csv" label="${tool.name} on ${on_string}"/>
0
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
23 </outputs>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
24
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
25 <tests>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
26 <test>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
27 <param name="input_counts" ftype="tabular" value="tiny.out.gz.CP009273.1_60_120.insert_site_plot.gz"/>
1
58234d95978d "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 61c83ac999a040604915ff7cf92670b2635b967e"
iuc
parents: 0
diff changeset
28 <param name="input_annot" ftype="embl" value="tiny_ref.embl"/>
0
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
29 <param name="trim3" ftype="float" value="0"/>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
30 <param name="trim5" ftype="float" value="0"/>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
31 <output name="gene_insert_sites" file="tiny.out.gz.CP009273.1_60_120.tradis_gene_insert_sites.csv" compare="sim_size" delta="200" />
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
32 </test>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
33 </tests>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
34 <help>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
35 <![CDATA[
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
36
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
37 **What is does**
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
38
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
39 Bio-TraDis provides software utilities for the processing, mapping, and analysis of transposon insertion sequencing data. The pipeline was designed with the data from the TraDIS sequencing protocol in mind, but should work with a variety of transposon insertion sequencing protocols as long as they produce data in the expected format.
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
40
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
41 tradis_gene_insert_sites that combine the counts at each position and an annotation file to provide the number of reads and insertion for each feature.
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
42
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
43 -----
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
44
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
45 **Output files**
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
46
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
47 The tool outputs a table containing the columns :
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
48 - locus_tag
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
49 - gene_name
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
50 - ncrna : Is the feature a non-coding DNA. 1=yes, 0=no.
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
51 - start
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
52 - end
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
53 - strand
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
54 - read_count : Numer of reads mapping on the feature
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
55 - ins_index : Insertion index, number of insertion divided by the gene length
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
56 - gene_length
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
57 - ins_count : Number of insertion within the feature.
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
58 - fcn : Function
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
59
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
60 -----
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
61
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
62 **More information**
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
63
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
64 .. class:: infomark
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
65
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
66 Additional information about Bio-TraDis can be found at https://github.com/sanger-pathogens/Bio-Tradis
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
67 ]]>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
68 </help>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
69
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
70 <expand macro="citations" />
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
71
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
72 </tool>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
73
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
74
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
75