annotate getfastaBed.xml @ 20:df56e1b12d0c draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 9f7b029951fa0f854c9c6a5f241ce9a20ae4f22a
author iuc
date Wed, 10 Jan 2018 19:21:33 -0500
parents 7308cc546a36
children 13400f3c3ec5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="bedtools_getfastabed" name="GetFastaBed" version="@WRAPPER_VERSION@.0">
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
2 <description>use intervals to extract sequences from a FASTA file</description>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <command>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
9 <![CDATA[
10
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
10 #if str( $fasta_source.fasta_source_selector ) == 'history':
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
11 #set $fasta_file = $fasta_source.fasta
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
12 #else
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
13 #set $fasta_file = $fasta_source.fasta_id.fields.path
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
14 #end if
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 bedtools getfasta
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
16 $name
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 $tab
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 $strand
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 $split
10
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
20 -fi '$fasta_file'
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
21 -bed '$input'
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
22 -fo '$output'
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
23 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 <inputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
26 <param format="bed,vcf,gff,gff3" name="input" type="data" label="BED/VCF/GFF file" />
10
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
27 <conditional name="fasta_source">
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
28 <param name="fasta_source_selector" type="select" label="Choose the source for the fasta file">
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
29 <option value="history" selected="True">History</option>
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
30 <option value="preloaded">Server indexed files</option>
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
31 </param>
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
32 <when value="history">
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
33 <param name="fasta" format="fasta" type="data" label="Fasta file" />
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
34 </when>
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
35 <when value="preloaded">
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
36 <param name="fasta_id" type="select">
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
37 <options from_data_table="all_fasta" />
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 10
diff changeset
38 </param>
10
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
39 </when>
c78cf6fe3018 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 44bebb8a97d64015cbba59f0663e2541035112b6
iuc
parents: 4
diff changeset
40 </conditional>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
41 <param name="name" type="boolean" checked="false" truevalue="-name" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
42 label="Use the 'name' column in the BED file for the FASTA headers in the output FASTA file"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 help="(-name)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
44 <param name="tab" type="boolean" checked="false" truevalue="-tab" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
45 label="Report extract sequences in a tab-delimited format instead of in FASTA format"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
46 help="(-tab)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
47 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 label="Force strandedness"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 help="If the feature occupies the antisense strand, the sequence will be reverse complemented. (-s)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
50 <expand macro="split" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
51 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
52 <outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
53 <data format="fasta" name="output">
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
54 <change_format>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
55 <when input="tab" value="-tab" format="tabular" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
56 </change_format>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
57 </data>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
59 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
60 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
61 <param name="input" value="nucBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
62 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
63 <param name="tab" value="False" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
64 <param name="split" value="False" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
65 <output name="output" file="getfastaBed_result1.bed" ftype="fasta" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
66 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
67 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
68 <param name="input" value="nucBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
69 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
70 <param name="tab" value="True" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
71 <param name="split" value="False" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
72 <output name="output" file="getfastaBed_result2.tabular" ftype="tabular" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
73 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
74 </tests>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
75 <help>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
76 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
77 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
78
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
79 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>”.
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
80
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
81 .. image:: $PATH_TO_IMAGES/getfasta-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
82
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
83 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
84
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
85 1. The headers in the input FASTA file must exactly match the chromosome column in the BED file.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
86
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
87 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
88
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
89 @REFERENCES@
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
90 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
91 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
92 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
93 </tool>