annotate tradis_essentiality.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_essentiality" name="Bio-TraDis Essentiality Predictions" 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 ln -s '$input_insert_file' input.csv &&
2
103bd59b3e33 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 6a29aaead9d6b0f69ef70113df58047877fc6ce5"
iuc
parents: 1
diff changeset
10 tradis_essentiality.R input.csv
0
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
11 ]]>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
12 </command>
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_insert_file" type="data" format="csv" label="Gene insertion counts" help="Ourput file of `Bio-TraDis counts to gene insertion data` tool"/>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
15 </inputs>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
16 <outputs>
2
103bd59b3e33 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 6a29aaead9d6b0f69ef70113df58047877fc6ce5"
iuc
parents: 1
diff changeset
17 <data name="ess_genes" format="csv" label="${tool.name} on ${on_string}: Essential genes" from_work_dir="input.csv.essen.csv"/>
103bd59b3e33 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 6a29aaead9d6b0f69ef70113df58047877fc6ce5"
iuc
parents: 1
diff changeset
18 <data name="ambig_genes" format="csv" label="${tool.name} on ${on_string}: Unclassified genes" from_work_dir="input.csv.ambig.csv"/>
103bd59b3e33 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 6a29aaead9d6b0f69ef70113df58047877fc6ce5"
iuc
parents: 1
diff changeset
19 <data name="all_genes" format="csv" label="${tool.name} on ${on_string}: All genes" from_work_dir="input.csv.all.csv"/>
103bd59b3e33 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 6a29aaead9d6b0f69ef70113df58047877fc6ce5"
iuc
parents: 1
diff changeset
20 <data name="qc_results" format="pdf" label="${tool.name} on ${on_string}: QC report" from_work_dir="input.csv.QC_and_changepoint_plots.pdf"/>
0
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
21 </outputs>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
22 <tests>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
23 <test>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
24 <param name="input_insert_file" ftype="csv" value="test.csv"/>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
25 <output name="ess_genes" file="test.csv.essen.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
26 <output name="ambig_genes" file="test.csv.ambig.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
27 <output name="all_genes" file="test.csv.all.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
28 </test>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
29 </tests>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
30 <help>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
31 <![CDATA[
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
32
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
33 **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
34
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
35 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
36
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
37 tradis_essentiality tool performs an Essentiality analysis using the annotation counts output of tradis_gene_insert_sites tool
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 -----
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 **Output files**
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 - Essential genes table : Table containing the essential genes
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
44 - Unclassified genes : Table containing genes that couldn't be classified as essential or non essential
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
45 - All genes : Table containing all genes
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
46 - QC report : PDF file containing the regression plot
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
47
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
48 All tables contain the following columns:
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
49 - locus_tag
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
50 - gene_name
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
51 - ncrna : Non-coding RNA, 1 if the feature is a non coding DNA, 0 if not.
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
52 - start
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
53 - end
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
54 - strand
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
55 - read_count : Total number 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
56 - 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
57 - gene_length
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
58 - 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
59 - fcn : Function
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
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
63 **More information**
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
64
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
65 .. class:: infomark
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
66
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
67 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
68 ]]>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
69 </help>
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
70
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
71 <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
72
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
73 </tool>
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
738e58ed9cc2 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tool_collections/biotradis commit 1c0a0f88149bf8863a89c58bace81e070b3adb5a"
iuc
parents:
diff changeset
76