annotate extract_aln_ends.xml @ 3:cb9827c97502 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a6a6774ae353f915a5ca34af8f281edd91e5c665
author iuc
date Fri, 04 Oct 2024 08:55:45 +0000
parents 44027547ce8f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
cb9827c97502 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a6a6774ae353f915a5ca34af8f281edd91e5c665
iuc
parents: 0
diff changeset
1 <tool id="bctools_extract_alignment_ends" name="Extract alignment ends" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
0
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
2 <description>from SAM or BAM</description>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
3 <macros>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
4 <import>macros.xml</import>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
5 </macros>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
8 extract_aln_ends.py
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
9 '$alignments'
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
10 > '$alignment_ends'
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
11 ]]></command>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
12 <inputs>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
13 <param name="alignments" type="data" format="sam,bam" label="Alignments in SAM or BAM format"/>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
14 </inputs>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
15 <outputs>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
16 <data name="alignment_ends" format="bed"/>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
17 </outputs>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
18 <tests>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
19 <test>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
20 <param name="alignments" value="twomates.sam"/>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
21 <output name="alignment_ends" file="tworeads_aln_ends.bed"/>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
22 </test>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
23 </tests>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
24 <help><![CDATA[
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
25
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
26 bctools - Extract alignment ends from from SAM or BAM alignments
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
27 ================================================================
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
28
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
29 The resulting BED file contains the outer coordinates of the alignments. The BED
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
30 name field is set to the read id and the score field is set to the edit distance
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
31 of the alignment. The crosslinked nucleotide is one nt upstream of the 5'-end of
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
32 the BED entries.
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
33
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
34 This tool only reports results for alignments that are properly aligned in FR
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
35 ("forward-reverse") direction.
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
36
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
37 Input:
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
38 ------
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
39
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
40 * BAM file containing alignments (paired-end sequencing)
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
41
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
42 Output:
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
43 -------
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
44
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
45 * BED file containing outer coordinates (sorted by read id)
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
46
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
47 ]]></help>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
48 <expand macro="citations"/>
44027547ce8f planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ae3b9baaf7040ed8b165d17466b8b2fe016d3d48
iuc
parents:
diff changeset
49 </tool>