annotate maskFastaBed.xml @ 35:b28e0cfa7ba1 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit fe3f54a0d3edb83fcf6752e3b1524c582b4febd5"
author iuc
date Fri, 06 Sep 2019 14:29:59 -0400
parents dde39ba9c031
children 3e38c9b3214f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
1 <tool id="bedtools_maskfastabed" name="bedtools MaskFastaBed" version="@TOOL_VERSION@">
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 mask 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" />
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
8 <command><![CDATA[
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
9 bedtools maskfasta
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
10 $soft
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
11 -mc '${mc}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
12 -fi '${fasta}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
13 -bed '${input}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
14 -fo '${output}'
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
15 $fullheader
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
16 ]]></command>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 <inputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
18 <param name="input" argument="-bed" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
19 <param name="fasta" argument="-fi" type="data" format="fasta" label="FASTA file"/>
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
20 <param argument="-soft" type="boolean" truevalue="-soft" falsevalue="" checked="false"
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
21 label="Soft-mask (that is, convert to lower-case bases) the FASTA sequence"
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
22 help="By default, hard-masking (that is, conversion to Ns) is performed" />
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
23 <param argument="-mc" type="text" value="N"
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
24 label="Replace masking character"
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
25 help="That is, instead of masking with Ns, use another character" />
33
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
26 <param argument="-fullHeader" name="fullheader" type="boolean" truevalue="-fullHeader" falsevalue=""
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
27 label="Use full fasta header."
19
a8eabd2838f6 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 542ddc9e98cee5cc2a9e4caae945dee4b2c747b8
iuc
parents: 10
diff changeset
28 help="By default, only the word before the first space or tab is used"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 <outputs>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
31 <data name="output" format="fasta" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
33 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
34 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
35 <param name="input" value="nucBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
36 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 <param name="soft" value="False" />
33
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
38 <output name="output" file="maskFastaBed_result1.fasta" ftype="fasta" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
39 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
41 <param name="input" value="nucBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
42 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 <param name="soft" value="True" />
33
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
44 <output name="output" file="maskFastaBed_result2.fasta" ftype="fasta" />
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
45 </test>
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
46 <test>
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
47 <param name="input" value="nucBed1.bed" ftype="bed" />
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
48 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
49 <param name="soft" value="True" />
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
50 <param name="fullheader" value="True" />
87ee588b3d45 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 32
diff changeset
51 <output name="output" file="maskFastaBed_result3.fasta" ftype="fasta" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
53 </tests>
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
54 <help><![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
55 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
56
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
57 bedtools maskfasta masks sequences in a FASTA file based on intervals defined in a feature file. The headers in the input FASTA file must exactly match the chromosome column in the feature file. This may be useful fro creating your own masked genome file based on custom annotations or for masking all but your target regions when aligning sequence data from a targeted capture experiment.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59 .. image:: $PATH_TO_IMAGES/maskfasta-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
60
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
61 @REFERENCES@
34
dde39ba9c031 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 33
diff changeset
62 ]]></help>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
64 </tool>