annotate getfastaBed.xml @ 56:7a06bb42dbb1 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
author iuc
date Tue, 31 Aug 2021 07:45:56 +0000
parents df28283b3778
children 1d0a0d6a78b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
1 <tool id="bedtools_getfastabed" name="bedtools GetFastaBed" version="@TOOL_VERSION@">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 8
diff changeset
2 <description>use intervals to extract sequences from a FASTA file</description>
56
7a06bb42dbb1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 50
diff changeset
3 <expand macro="bio_tools" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <expand macro="stdio" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
9 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 #if str($fasta_source.fasta_source_selector) == 'history':
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 #set $fasta_file = $fasta_source.fasta
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 #else
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 #set $fasta_file = $fasta_source.fasta_id.fields.path
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
15 bedtools getfasta
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 $name
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 $tab
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
18 $strand
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
19 $split
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
20 -fi '$fasta_file'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
21 -bed '$input'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
22 -fo '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
23 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
25 <param name="input" argument="-bed" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file" />
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
26 <conditional name="fasta_source">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
27 <param name="fasta_source_selector" type="select" label="Choose the source for the FASTA file">
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
28 <option value="history" selected="true">History</option>
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
29 <option value="preloaded">Server indexed files</option>
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
30 </param>
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
31 <when value="history">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
32 <param name="fasta" argument="-fi" type="data" format="fasta" label="FASTA file" />
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
33 </when>
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
34 <when value="preloaded">
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
35 <param name="fasta_id" type="select">
39
da6d7bc0a8b0 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6418f2e58def1a81b3aa7c04cb5dc33decea1a96
iuc
parents: 26
diff changeset
36 <options from_data_table="fasta_indexes" />
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
37 </param>
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
38 </when>
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
39 </conditional>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
40 <param argument="-name" type="boolean" truevalue="-name" falsevalue="" checked="false"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
41 label="Use the 'name' column in the BED file for the FASTA headers in the output FASTA file" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
42 <param argument="-tab" type="boolean" truevalue="-tab" falsevalue="" checked="false"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
43 label="Report extract sequences in a tab-delimited format instead of in FASTA format" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
44 <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 label="Force strandedness"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
46 help="If the feature occupies the antisense strand, the sequence will be reverse complemented" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <expand macro="split" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
50 <data name="output" format="fasta">
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 <change_format>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 <when input="tab" value="-tab" format="tabular" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 </change_format>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 </data>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 <param name="input" value="nucBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 <param name="tab" value="False" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 <param name="split" value="False" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 <output name="output" file="getfastaBed_result1.bed" ftype="fasta" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 <param name="input" value="nucBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 <param name="tab" value="True" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 <param name="split" value="False" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 <output name="output" file="getfastaBed_result2.tabular" ftype="tabular" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
72 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
73 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
74
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
75 bedtools getfasta will extract the sequence defined by the coordinates in a BED interval and create a new FASTA entry in the output file for each extracted sequence. By default, the FASTA header for each extracted sequence will be formatted as follows: “>chrom>:&lt;start>-&lt;end>”.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
76
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
77 .. image:: $PATH_TO_IMAGES/getfasta-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
78
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
79 .. class:: warningmark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
80
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
81 1. The headers in the input FASTA file must exactly match the chromosome column in the BED file.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
82
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
83 2. You can use the UNIX fold command to set the line width of the FASTA output. For example, fold -w 60 will make each line of the FASTA file have at most 60 nucleotides for easy viewing.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
84
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
85 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
86 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
87 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
88 </tool>