annotate microsatbed.xml @ 30:53c4f91c6031 draft default tip

planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
author fubar
date Sat, 20 Jul 2024 01:44:09 +0000
parents efc775ab30fe
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
1 <tool name="STR to bed" id="microsatbed" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="22.05">
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
2 <description>Short Tandem Repeats to bed features from fasta</description>
30
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
3 <macros>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
4 <token name="@TOOL_VERSION@">1.3.2</token>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
6 <token name="@PYFASTX_VERSION@">2.1.0</token>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
7 <token name="@PYTHON_VERSION@">3.12.3</token>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
8 <token name="@UCSC_VERSION@">455</token>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
9 </macros>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
10 <requirements>
30
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
11 <requirement version="@PYTHON_VERSION@" type="package">python</requirement>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
12 <requirement version="@PYFASTX_VERSION@" type="package">pyfastx</requirement>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
13 <requirement version="@TOOL_VERSION@" type="package">pytrf</requirement>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
14 <requirement version="@UCSC_VERSION@" type="package">ucsc-bedgraphtobigwig</requirement>
26
26e9575c2c83 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 23
diff changeset
15
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
16 </requirements>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
17 <required_files>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
18 <include path="find_str.py"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
19 </required_files>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
20 <version_command><![CDATA[python -c "import pytrf; from importlib.metadata import version; print(version('pytrf'))"]]></version_command>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
21 <command><![CDATA[
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
22 #if $mode_cond.mode == "NATIVE":
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
23 #if $reference_genome.genome_type_select == "history":
30
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
24 pytrf findstr -f '$mode_cond.outformat' -o '$bed' -r '$monomin' '$dimin' '$trimin' '$tetramin' '$pentamin' '$hexamin' '${reference_genome.fasta}'
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
25 #else:
30
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
26 pytrf findstr -f '$mode_cond.outformat' -o '$bed' -r '$monomin' '$dimin' '$trimin' '$tetramin' '$pentamin' '$hexamin' '${reference_genome.fasta.fields.path}'
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
27 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
28 #else:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
29 python '${__tool_directory__}/find_str.py'
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
30 #if $reference_genome.genome_type_select == "history":
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
31 --fasta '${reference_genome.fasta}'
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
32 #else:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
33 --fasta '${reference_genome.fasta.fields.path}'
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
34 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
35 --bed '$bed'
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
36 #if $mode_cond.mode == "SPECIFIC":
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
37 --specific '$mode_cond.specific'
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
38 #elif $mode_cond.mode == "SPECIFICBW":
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
39 --bigwig
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
40 --winwidth '$mode_cond.winwidth'
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
41 --specific '$mode_cond.specific'
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
42 #else:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
43 #if "MONO" in $mode_cond.subset:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
44 --mono
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
45 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
46 #if "DI" in $mode_cond.subset:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
47 --di
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
48 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
49 #if "TRI" in $mode_cond.subset:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
50 --tri
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
51 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
52 #if "TETRA" in $mode_cond.subset:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
53 --tetra
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
54 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
55 #if "PENTA" in $mode_cond.subset:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
56 --penta
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
57 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
58 #if "HEXA" in $mode_cond.subset:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
59 --hexa
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
60 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
61 #end if
18
607620f93b4c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 17
diff changeset
62 --monomin '$monomin'
607620f93b4c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 17
diff changeset
63 --dimin '$dimin'
607620f93b4c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 17
diff changeset
64 --trimin '$trimin'
607620f93b4c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 17
diff changeset
65 --tetramin '$tetramin'
607620f93b4c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 17
diff changeset
66 --pentamin '$pentamin'
607620f93b4c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 17
diff changeset
67 --hexamin '$hexamin'
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
68 #if $mode_cond.mode == "SPECIFICBW":
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
69 --bigwig
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
70 --winwidth '$mode_cond.winwidth'
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
71 #end if
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
72 #end if
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
73 ]]></command>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
74 <inputs>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
75 <conditional name="reference_genome">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
76 <param name="genome_type_select" type="select" label="Select a source for fasta sequences to be searched for STRs" help="Options are to choose a built-in genome, or choose any history fasta file">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
77 <option value="indexed">Use a Galaxy server built-in reference genome fasta</option>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
78 <option value="history" selected="True">Use any fasta file from the current history</option>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
79 </param>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
80 <when value="indexed">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
81 <param name="fasta" type="select" multiple="false" label="Choose a built-in genome"
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
82 help="If the genome you need is not on the list, upload it and select it as a current history fasta">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
83 <options from_data_table="all_fasta"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
84 </param>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
85 </when>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
86 <when value="history">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
87 <param name="fasta" type="data" format="fasta,fasta.gz" optional="false" multiple="false" label="Choose a fasta file from the current history"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
88 </when>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
89 </conditional>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
90 <conditional name="mode_cond">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
91 <param name="mode" type="select" label="Select patterns by motif length; or provide a specific motif pattern to report?" help="Choose *By length:* or *By pattern:* to configure STR selection mode">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
92 <option selected="True" value="ALL">By length: Report all motifs of one or more specified lengths (1-6nt) as bed features</option>
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
93 <option value="ALLBW">By length as windowed bigwig: Report all motifs of one or more specified lengths (1-6nt) as windowed density</option>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
94 <option value="SPECIFIC">By motif: Report one or more specific motifs (such as TCA,GC) as bed features</option>
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
95 <option value="SPECIFICBW">By motif as windowed bigwig: Report one or more specific motifs (such as TCA,GC) as windowed density</option>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
96 <option value="NATIVE">All exact STR: use the pytrf findstr native command to a create csv, tsv or gtf output</option>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
97 </param>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
98 <when value="ALL">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
99 <param name="subset" type="select" multiple="true" optional="false" label="Select at least 1 specific motif length to report"
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
100 help="Bed features will be output for every motif of the selected length(s) with the minimum required repeats or more">
17
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
101 <option value="DI" selected="true">All dimers (AC,AG,AT,...)</option>
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
102 <option value="TRI">All trimers (ACG,..)</option>
23
45f690db0eaf planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 22
diff changeset
103 <option value="TETRA">All tetramers (ACGT,..)</option>
17
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
104 <option value="PENTA">All pentamers (ACGTC,..)</option>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
105 <option value="HEXA">All hexamers (ACGTCG,..)</option>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
106 <option value="MONO">All monomers (A,C...). Warning! Can produce overwhelming numbers of bed features</option>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
107 </param>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
108 </when>
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
109 <when value="ALLBW">
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
110 <param name="subset" type="select" multiple="true" optional="false" label="Select at least 1 specific motif length to report"
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
111 help="Bed features will be output for every motif of the selected length(s) with the minimum required repeats or more">
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
112 <option value="DI" selected="true">All dimers (AC,AG,AT,...)</option>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
113 <option value="TRI">All trimers (ACG,..)</option>
23
45f690db0eaf planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 22
diff changeset
114 <option value="TETRA">All tetramers (ACGT,..)</option>
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
115 <option value="PENTA">All pentamers (ACGTC,..)</option>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
116 <option value="HEXA">All hexamers (ACGTCG,..)</option>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
117 <option value="MONO">All monomers (A,C...). Warning! Can produce overwhelming numbers of bed features</option>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
118 </param>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
119 <param type="integer" min="5" name="winwidth" label="Window with for estimating STR bigwig density" value="128"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
120 </when>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
121 <when value="SPECIFIC">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
122 <param name="specific" type="text" label="Supply a specific motif pattern. Separate multiple patterns with commas such as GA,GC"
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
123 help="Make bed features only for the nominated specific motifs." optional="false"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
124 </when>
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
125 <when value="SPECIFICBW">
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
126 <param name="specific" type="text" label="Supply a specific motif pattern. Separate multiple patterns with commas such as GA,GC"
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
127 help="Make bed features only for the nominated specific motifs." optional="false"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
128 <param type="integer" min="5" name="winwidth" label="Window with for estimating STR bigwig density" value="128"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
129 </when>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
130 <when value="NATIVE">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
131 <param name="outformat" type="select" optional="false" label="Select the required output format"
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
132 help="Pytrf can create GFF, CSV or TSV output files. Documentation is linked in the help section below">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
133 <option value="gff" >GFF</option>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
134 <option value="csv">Comma separated values</option>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
135 <option value="tsv" selected="true">Tab separated values</option>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
136 </param>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
137 </when>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
138 </conditional>
30
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
139 <param type="integer" label="Minimum repeats required for monomers" min="2" name="monomin" value="10"/>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
140 <param type="integer" label="Minimum repeats required for dimers" min="1" name="dimin" value="3"/>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
141 <param type="integer" label="Minimum repeats required for trimers" min="2" name="trimin" value="2"/>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
142 <param type="integer" label="Minimum repeats required for tetramers" min="2" name="tetramin" value="2"/>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
143 <param type="integer" label="Minimum repeats required for pentamers" min="2" name="pentamin" value="2"/>
53c4f91c6031 planemo upload for repository https://github.com/fubar2/microsatbed commit 80a8c0db54b6e2cab9dfe7178b1e5b3b39592f2c
fubar
parents: 29
diff changeset
144 <param type="integer" label="Minimum repeats required for hexamers" min="2" name="hexamin" value="2"/>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
145 </inputs>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
146 <outputs>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
147 <data name="bed" format="bed" label="STR from $fasta.element_identifier" hidden="false">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
148 <change_format>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
149 <when input="mode_cond.outformat" value="gff" format="gff" />
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
150 <when input="mode_cond.outformat" value="csv" format="csv" />
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
151 <when input="mode_cond.outformat" value="tsv" format="tabular" />
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
152 <when input="mode_cond.mode" value="ALLBW" format="bigwig" />
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
153 <when input="mode_cond.mode" value="SPECIFICBW" format="bigwig" />
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
154 </change_format>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
155 </data>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
156 </outputs>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
157 <tests>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
158 <test expect_num_outputs="1">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
159 <conditional name="reference_genome">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
160 <param name="genome_type_select" value="history"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
161 <param name="fasta" value="humsamp.fa"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
162 </conditional>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
163 <conditional name="mode_cond">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
164 <param name="mode" value="ALL"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
165 <param name="subset" value="DI,TRI,TETRA,PENTA,HEXA"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
166 </conditional>
17
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
167 <param name="monomin" value="20"/>
19
db5523378e5c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 18
diff changeset
168 <param name="dimin" value="20"/>
db5523378e5c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 18
diff changeset
169 <param name="trimin" value="5"/>
db5523378e5c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 18
diff changeset
170 <param name="tetramin" value="5"/>
db5523378e5c planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 18
diff changeset
171 <param name="pentamin" value="3"/>
17
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
172 <param name="hexamin" value="2"/>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
173 <output name="bed" value="bed_sample" compare="diff" lines_diff="0"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
174 </test>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
175 <test expect_num_outputs="1">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
176 <conditional name="reference_genome">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
177 <param name="genome_type_select" value="history"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
178 <param name="fasta" value="humsamp.fa"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
179 </conditional>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
180 <conditional name="mode_cond">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
181 <param name="mode" value="SPECIFIC"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
182 <param name="specific" value="GC"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
183 </conditional>
17
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
184 <param name="monomin" value="20"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
185 <param name="dimin" value="1"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
186 <param name="trimin" value="20"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
187 <param name="tetramin" value="20"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
188 <param name="pentamin" value="20"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
189 <param name="hexamin" value="20"/>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
190 <output name="bed" value="dibed_sample" compare="diff" lines_diff="0"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
191 </test>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
192 <test expect_num_outputs="1">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
193 <conditional name="reference_genome">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
194 <param name="genome_type_select" value="history"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
195 <param name="fasta" value="mouse.fa"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
196 </conditional>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
197 <conditional name="mode_cond">
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
198 <param name="mode" value="NATIVE"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
199 <param name="outformat" value="gff"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
200 </conditional>
17
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
201 <param name="monomin" value="20"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
202 <param name="dimin" value="10"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
203 <param name="trimin" value="5"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
204 <param name="tetramin" value="4"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
205 <param name="pentamin" value="4"/>
264d79548d19 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 16
diff changeset
206 <param name="hexamin" value="2"/>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
207 <output name="bed" value="nativegff_sample" compare="diff" lines_diff="0"/>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
208 </test>
20
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
209 <test expect_num_outputs="1">
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
210 <conditional name="reference_genome">
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
211 <param name="genome_type_select" value="history"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
212 <param name="fasta" value="humsamp.fa"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
213 </conditional>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
214 <conditional name="mode_cond">
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
215 <param name="mode" value="SPECIFICBW"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
216 <param name="specific" value="GC"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
217 </conditional>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
218 <param name="monomin" value="20"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
219 <param name="dimin" value="1"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
220 <param name="trimin" value="20"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
221 <param name="tetramin" value="20"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
222 <param name="pentamin" value="20"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
223 <param name="hexamin" value="20"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
224 <output name="bed" value="dibed_wig_sample" compare="sim_size" delta="10"/>
410144c7b2d6 planemo upload for repository https://github.com/fubar2/microsatbed commit d952bc313f408735456747c3d33e09a3170c8f59-dirty
fubar
parents: 19
diff changeset
225 </test>
11
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
226 </tests>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
227 <help><![CDATA[
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
228
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
229 **Convert short repetitive sequences to bed features**
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
230
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
231 Microsatellites are usually defined as repeated short DNA patterns in an unbroken sequence.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
232 A microsatellite pattern or *motif* can be any combination nucleotides, typically from 1 to 6nt in length.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
233
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
234 This tool allows microsatellite and related features to be selected from a fasta sequence input file, and output into a single bed track, suitable for viewing in a genome browser such as JBrowse2.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
235
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
236 All motifs of selected lengths can be reported as individual features in the output bed file, or specific motifs can be provided and all
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
237 others will be ignored. In all cases, a minimum required number of repeats can be specified. For example, requiring 2 or more repeats of the trimer *ACG* will report
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
238 every sequence of *ACGACG* or *ACGACGACG* or *ACGACGACGACG* and so on, as individual bed features. Similarly, requiring 3 repeats of any trimer will
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
239 report every distinct 3 nucleotide pattern, including *ACGACGACG* as well as every other unique 3 nucleotide pattern with 3 sequential repeats or more such, as "CTCCTCCTC*.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
240
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
241 For other output formats, the pytrf native command line *findstr* can be used to produce a gff, csv or tsv output containing all exact short tandem repeats, as
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
242 described at the end of https://pytrf.readthedocs.io/en/latest
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
243
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
244 A fasta file must be supplied for processing. A built in genome can be selected, or a fasta file of any kind can be selected from the current history. Note that all
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
245 symbols are treated as valid nucleotides by pytrf, so extraneous characters such as *-* or *N* in the input fasta may appear as unexpected bed features. Lower case fasta symbols will be converted
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
246 to uppercase, to prevent them being reported as distinct motifs.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
247
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
248
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
249 **Select motifs by length**
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
250
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
251 The default tool form setting is to select all dimer motif patterns.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
252
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
253 Additional motif lengths from 1 to 6nt can be selected in the multiple-select drop-down list. All features will be returned in a single bed file. For each selected motif length,
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
254 the minimum number of repeats required for reporting can be adjusted. **Tandem repeats** are defined as at least 2 of any pattern. This tool allows singleton motifs to be reported,
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
255 so is not restricted to short tandem repeats (STR)
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
256
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
257 **Select motifs by pattern**
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
258
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
259 This option allows a motif pattern to be specified as a text string such as *CG* or *ATC*. Multiple motifs can be specified as a comma separated string such as *CG,ATC*.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
260 All features will be returned as a single bed file.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
261
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
262 The minimum number of repeats for all motifs can be set to match specific requirements.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
263
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
264 For example, technical sequencing read bias may be influenced by the density of specific dimers, whether they are repeated or not
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
265 such as in https://github.com/arangrhie/T2T-Polish/tree/master/pattern
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
266
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
267 **Select all perfect STR using pytrf findstr in csv, tsv or gff output format**
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
268
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
269 This selection runs the pytrf *findstr* option to create gff/csv/tsv outputs as described at the end of https://pytrf.readthedocs.io/en/latest/.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
270
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
271 Quoted here:
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
272
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
273 *A Tandem repeat (TR) in genomic sequence is a set of adjacent short DNA sequence repeated consecutively. The core sequence or repeat unit is generally called motif.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
274 According to the motif length, tandem repeats can be classified as microsatellites and minisatellites. Microsatellites are also known as simple sequence repeats (SSRs)
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
275 or short tandem repeats (STRs) with motif length of 1-6 bp. Minisatellites are also sometimes referred to as variable number of tandem repeats (VNTRs) has longer motif length than microsatellites.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
276 Pytrf is a lightweight Python C extension for identification of tandem repeats. The pytrf enables to fastly identify both exact or perfect SSRs.
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
277 It also can find generic tandem repeats with any size of motif, such as with maximum motif length of 100 bp. Additionally, it has capability of finding approximate or imperfect tandem repeats*
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
278
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
279 ]]></help>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
280 <citations>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
281 <citation type="bibtex">@misc{pytrf,
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
282 title = {{pytrf} Short tandem repeat finder, Accessed on July 10 2024},
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
283 howpublished = {\url{https://github.com/lmdu/pytrf}},
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
284 note = {Accessed on July 10 2024}
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
285 }</citation>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
286 </citations>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
287 </tool>
a633c1c45da3 Uploaded
fubar
parents:
diff changeset
288