annotate delta-filter.xml @ 4:e8fdceffea4c draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 026db7297e987c1b7ce7f5dd4f8746d1bd435538
author iuc
date Mon, 18 Mar 2024 12:41:50 +0000
parents fbca557a4847
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
fbca557a4847 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit bacb32814054404587451948b3a6682cf0d1a33a"
iuc
parents: 1
diff changeset
1 <tool id="mummer_delta_filter" name="Delta-Filter" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
2 <description>Filters alignment (delta) file from nucmer</description>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
3 <macros>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
4 <import>macros.xml</import>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
5 </macros>
3
fbca557a4847 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit bacb32814054404587451948b3a6682cf0d1a33a"
iuc
parents: 1
diff changeset
6 <expand macro="bio_tools"/>
0
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
7 <expand macro="requirements" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
8 <command detect_errors="exit_code">
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
9 <![CDATA[
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
10 delta-filter
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
11 $alignment
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
12 -i '$min_identity'
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
13 -l '$min_length'
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
14 $overlap
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
15 -u '$min_uniqueness'
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
16 -o '$max_overlap'
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
17 '$delta' > '$output'
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
18 ]]>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
19 </command>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
20 <inputs>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
21 <param name="delta" type="data" format="tabular" label="Match file from nucmer" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
22 <param name="alignment" type="select" label="Alignment Strategy" >
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
23 <option value="-m">Use default [Many-to-many alignment allowing for rearrangements] (-m)</option>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
24 <option value="-1">1-to-1 alignment allowing for rearrangements (-1)</option>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
25 <option value="-g">1-to-1 global alignment not allowing rearrangements (-g)</option>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
26 </param>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
27 <param name="min_identity" type="float" argument="-i" value="0" min="0" max="100" label="Minimum Identity" help="Set the minimum alignment identity. (-i)" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
28 <param name="min_length" type="integer" argument="-l" value="0" label="Minumum Legnth" help="Set the minimum alignment length. (-l)" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
29 <param name="overlap" type="select" label="Overlaps"
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
30 help=" Maps each position of each query/reference to its best hit in the reference/query, allowing for reference/query overlaps." >
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
31 <option value="-q">Reference overlaps (-q)</option>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
32 <option value="-r">Query overlaps (-r)</option>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
33 </param>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
34 <param name="min_uniqueness" type="float" argument="-u" value="0" min="0" max="100" label="Minimum Alignment Uniqueness"
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
35 help="Set the minimum alignment uniqueness, i.e. percent of the alignment matching to unique reference AND query sequence. (-u)" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
36 <param name="max_overlap" type="float" argument="-o" value="100" min="0" max="100" label="Maximum Alignment Overlap"
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
37 help="Set the maximum alignment overlap for overlap options as a percent of the alignment length. (-o)" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
38 </inputs>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
39 <outputs>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
40 <data name="output" format="tabular" from_work_dir="delta-filter.txt"/>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
41 </outputs>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
42 <tests>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
43 <test>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
44 <param name="delta" ftype="tabular" value="nucmer.txt" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
45 <output name="output" ftype="tabular" compare="diff" lines_diff="2" value="delta-filter.txt" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
46 </test>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
47 </tests>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
48 <help><![CDATA[
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
49 This program filters the alignment file produced by nucmer, leaving only the desired alignments. Its primary function is the LIS algorithm which calculates the longest increasing subset of alignments. This allows for the calculation of a global set of alignments (i.e. 1-to-1 and mutually consistent order) with the 1-1 global option or locally consistent with 1-1 with rearrangements or many-to-many alignment. Reference sequences can be mapped to query sequences with the reference option of the Overlaps parameter, or queries to references with the Query option. This allows the user to exclude chance and repeat induced alignments, leaving only the "best" alignments between the two data sets. Filtering can also be performed on length, identity, and uniqueness.
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
50
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
51 An important distinction between the alignment options is that 1-1 global requires the alignments to be mutually consistent in their order, while the other options are not required to be mutually consistent and therefore tolerate translocations, inversions, etc.
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
52
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
53 In general cases, the many-to-many option is the best choice, however 1-1 alignment allowing for rearrangements can be handy for applications such as SNP finding which require a 1-to-1 mapping.
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
54
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
55 Finally, for mapping query contigs, or sequencing reads, to a reference genome, use the query option for the Overlaps parameter.
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
56
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
57 **Options**::
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
58
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
59 -m Many-to-many alignment allowing for rearrangements
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
60
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
61 -1 1-to-1 alignment allowing for rearrangements
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
62
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
63 -g 1-to-1 global alignment not allowing rearrangements
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
64
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
65 -i Set the minimum alignment identity [0, 100], default 0
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
66
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
67 -l Set the minimum alignment length, default 0
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
68
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
69 -q Maps each position of each query to its best hit in the reference, allowing for reference
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
70 overlaps
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
71
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
72 -r Maps each position of each reference to its best hit in the query, allowing for query overlaps
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
73
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
74 -u Set the minimum alignment uniqueness, i.e. percent of the alignment matching to unique reference
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
75 AND query sequence [0,100], default 0
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
76
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
77 -o Set the maximum alignment overlap for -r and -q options as a percent of the alignment length
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
78 [0, 100], default 100
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
79
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
80 ]]></help>
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
81 <expand macro="citation" />
502018997bae planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mummer4 commit 8133565adbfc012fa54b96449c2a18d044049107
iuc
parents:
diff changeset
82 </tool>