annotate maskFastaBed.xml @ 64:f6c88d2e9ae5 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
author iuc
date Fri, 21 Feb 2025 21:38:34 +0000
parents 539958feb49c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
1d0a0d6a78b1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 56
diff changeset
1 <tool id="bedtools_maskfastabed" name="bedtools MaskFastaBed" version="@TOOL_VERSION@" profile="@PROFILE@">
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>
59
539958feb49c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 500a03281ea704abc7a16d9af63d67dbdcc5cd0b"
iuc
parents: 57
diff changeset
6 <expand macro="bio_tools" />
8
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: 49
diff changeset
9 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
10 bedtools maskfasta
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
11 $soft
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
12 -mc '${mc}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
13 -fi '${fasta}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
14 -bed '${input}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
15 -fo '${output}'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
16 $fullheader
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
17 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 <inputs>
50
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="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
20 <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
21 <param argument="-soft" type="boolean" truevalue="-soft" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 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
23 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
24 <param argument="-mc" type="text" value="N"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 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
26 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
27 <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
28 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
29 help="By default, only the word before the first space or tab is used"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
32 <data name="output" format="fasta" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <param name="input" value="nucBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <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
39 <output name="output" file="maskFastaBed_result1.fasta" ftype="fasta" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <param name="input" value="nucBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <param name="fasta" value="nucBed1.fasta" ftype="fasta" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 <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
45 <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
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 <test>
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="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
49 <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
50 <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
51 <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
52 <output name="output" file="maskFastaBed_result3.fasta" ftype="fasta" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
55 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 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
59
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 .. image:: $PATH_TO_IMAGES/maskfasta-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 49
diff changeset
63 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 </tool>