annotate TEfinder.xml @ 0:b81a83c743d3 draft default tip

Uploaded
author namhsuya
date Tue, 09 Aug 2022 06:58:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
1 <tool id="te_finder_1" name="TEfinder" version="1.0.1" profile="21.05">
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
2 <description>A bioinformatics tool for detecting novel transposable element insertions</description>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
3
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
4 <requirements>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
5 <requirement type="package" version="1.15.1">samtools</requirement>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
6 <requirement type="package" version="2.30.0">bedtools</requirement>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
7 <requirement type="package" version="2.27.4">picard</requirement>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
8 <requirement type="package" version="3.4">grep</requirement>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
9 <requirement type="package" version="1.07.1">bc</requirement>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
10 </requirements>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
11
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
12 <command>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
13 <![CDATA[
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
14 '$__tool_directory__/TEfinder' -fa '$required_inputs.FastaFile'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
15 -alignment '$required_inputs.alignmentFile'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
16 -gtf '$required_inputs.TransposonsInGenome'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
17 -te '$required_inputs.TransposonsToSearch'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
18 -bamo '$discordantreads'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
19 -bedo '$bteinsertion'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
20 -threads '\${GALAXY_SLOTS:-1}'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
21 -fis $($advanced_options.FragmentInsertSize)
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
22 -md $($advanced_options.MaxDistanceForMerge)
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
23 -k $($advanced_options.MaxTSDLength)
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
24 #if str( $advanced_options.OutFormat) == "gtf":
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
25 -gtfo '$gteinsertion'
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
26 -out $($advanced_options.OutFormat)
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
27 #end if
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
28 ]]>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
29 </command>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
30
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
31 <inputs>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
32 <!-- <param format="fasta" name="input" type="data" label="Source file"/> -->
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
33 <section name="required_inputs" title="Required Inputs" expanded="True">
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
34 <param name="FastaFile" type="data" format="fasta" label="Select reference genome FASTA index (FA/FASTA file)" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
35 <param name="alignmentFile" type="data" format="bam" label="Select sample reads aligned to reference genome (BAM/SAM file)" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
36 <param name="TransposonsInGenome" type="data" format="gtf" label="Select reference genome TE annotation (GFF/GTF file)" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
37 <param name="TransposonsToSearch" type="data" format="text" label="Select TE names (single column text file)" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
38 </section>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
39 <!-- Advanced Options -->
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
40 <section name="advanced_options" title="Advanced Options" expanded="False">
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
41 <param name="FragmentInsertSize" argument="-fis" type="integer" min="0" value="400" label="Short-read sequencing fragment insert size [400]" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
42 <param name="MaxDistanceForMerge" argument="-md" type="integer" min="0" value="150" label="Maximum distance between reads for bedtools merge" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
43 <param name="MaxTSDLength" argument="-k" type="integer" min="0" value="20" label="Maximum TE target site duplication (TSD) length" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
44 <param name="OutFormat" argument="-out" type="select" display="radio" label="Select output format as GTF [BED]" help="See help below for more details">
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
45 <option value="gtf">Other available format is GTF (-out gtf)</option>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
46 <option value="bed" selected="True">Default format is BED</option>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
47 </param>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
48 </section>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
49 </inputs>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
50
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
51 <outputs>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
52 <data format="bed" name="bteinsertion" label="${tool.name} on ${on_string}: BED" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
53 <data format="gtf" name="gteinsertion" label="${tool.name} on ${on_string}: GTF">
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
54 <filter>advanced_options['OutFormat'] and 'gtf' in advanced_options['OutFormat']</filter>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
55 </data>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
56 <data format="bam" name="discordantreads" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
57 </outputs>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
58
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
59 <tests>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
60 <!-- Test for the most simple case for BED output : Running TEfinder with a .bam file and a .fasta file -->
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
61 <test expect_num_outputs="2">
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
62 <!-- TEfinder commands: TEfinder -alignment sample.bam -fa reference.fa -gtf TEs.gtf -te List_of_TEs.txt -->
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
63 <param name="FastaFile" ftype="fasta" value="reference.fa"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
64 <param name="alignmentFile" ftype="bam" value="sample.bam"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
65 <param name="TransposonsInGenome" ftype="gtf" value="TEs.gtf"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
66 <param name="TransposonsToSearch" ftype="txt" value="List_of_TEs.txt"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
67 <param name="OutFormat" value="bed" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
68 <output name="bteinsertion" file="TEinsertions.bed" ftype="bed"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
69 <output name="discordantreads" file="DiscordantReads.bam" ftype="bam"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
70 </test>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
71
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
72 <!-- Test for the GTF output -->
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
73 <test expect_num_outputs="3">
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
74 <!-- TEfinder commands: TEfinder -alignment sample.bam -fa reference.fa -gtf TEs.gtf -te List_of_TEs.txt -out gtf -->
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
75 <param name="FastaFile" ftype="fasta" value="reference.fa"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
76 <param name="alignmentFile" ftype="bam" value="sample.bam"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
77 <param name="TransposonsInGenome" ftype="gtf" value="TEs.gtf"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
78 <param name="TransposonsToSearch" ftype="txt" value="List_of_TEs.txt"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
79 <param name="OutFormat" value="gtf" />
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
80 <output name="bteinsertion" file="TEinsertions.bed" ftype="bed"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
81 <output name="gteinsertion" file="TEinsertions.gtf" ftype="gtf"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
82 <output name="discordantreads" file="DiscordantReads.bam" ftype="bam"/>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
83 </test>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
84 </tests>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
85
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
86 <help>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
87 <![CDATA[
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
88 A bioinformatics tool for detecting novel transposable element insertions
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
89
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
90 Authors: Vista Sohrab & Dilay Hazal Ayhan
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
91
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
92 TEfinder uses discordant reads to detect novel transposable element insertion events in paired-end sample sequencing data.
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
93
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
94 **Output files**::
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
95
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
96 TE_insertions.bed contains identified TE insertion events in sample (in the final column, FILTER attribute with "PASS" refers to high confidence insertion events while instances labeled as "in_repeat", "weak_evidence", "strand bias" or a combination of these three labels indicate less confident insertion events)
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
97
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
98 TE_insertions.gtf is provided with the same information as the BED file if using -out GTF
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
99
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
100 DiscordantReads.bam contains all discordant reads that have been identified based on the TEs of interest that have been submitted to TEfinder
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
101
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
102 **Note**::
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
103
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
104 Modifying the maximum TSD length (-k) could be useful if there is an unexpected number of insertion events identified with the default parameter. The optimal maximum TSD length can vary across datasets.
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
105 Modifying the fragment insert size (-fis) based on the sequencing library preparation can be useful.
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
106
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
107 ]]>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
108 </help>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
109
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
110 <citations>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
111 <citation type="doi">10.5281/zenodo.4479946</citation>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
112 </citations>
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
113
b81a83c743d3 Uploaded
namhsuya
parents:
diff changeset
114 </tool>