annotate maskFastaBed.xml @ 55:678ea22d643d draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b822ff8f05f2396fc15bd95a71bc6878503081eb"
author iuc
date Thu, 06 May 2021 14:14:33 +0000
parents df28283b3778
children 7a06bb42dbb1
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: 49
diff changeset
1 <tool id="bedtools_maskfastabed" name="bedtools MaskFastaBed" 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 mask sequences from a FASTA file</description>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
8 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
9 bedtools maskfasta
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
10 $soft
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
11 -mc '${mc}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
12 -fi '${fasta}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
13 -bed '${input}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
14 -fo '${output}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
15 $fullheader
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
16 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
18 <param name="input" argument="-bed" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
19 <param name="fasta" argument="-fi" type="data" format="fasta" label="FASTA file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
20 <param argument="-soft" type="boolean" truevalue="-soft" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 label="Soft-mask (that is, convert to lower-case bases) the FASTA sequence"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
22 help="By default, hard-masking (that is, conversion to Ns) is performed" />
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
23 <param argument="-mc" type="text" value="N"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 label="Replace masking character"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
25 help="That is, instead of masking with Ns, use another character" />
49
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
26 <param argument="-fullHeader" name="fullheader" type="boolean" truevalue="-fullHeader" falsevalue=""
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
27 label="Use full fasta header."
35
ac2040a5e6ff planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 542ddc9e98cee5cc2a9e4caae945dee4b2c747b8
iuc
parents: 26
diff changeset
28 help="By default, only the word before the first space or tab is used"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
31 <data name="output" format="fasta" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <param name="input" value="nucBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <param name="soft" value="False" />
49
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
38 <output name="output" file="maskFastaBed_result1.fasta" ftype="fasta" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <param name="input" value="nucBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <param name="soft" value="True" />
49
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
44 <output name="output" file="maskFastaBed_result2.fasta" ftype="fasta" />
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
45 </test>
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
46 <test>
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
47 <param name="input" value="nucBed1.bed" ftype="bed" />
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
48 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
49 <param name="soft" value="True" />
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
50 <param name="fullheader" value="True" />
5074e81a5ce1 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0a8cabcc8f00014789b6d30e90be1b949d4e94d2
iuc
parents: 48
diff changeset
51 <output name="output" file="maskFastaBed_result3.fasta" ftype="fasta" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
54 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56
0d3aa592ce27 Uploaded
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.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 .. image:: $PATH_TO_IMAGES/maskfasta-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
62 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 </tool>