annotate illuminapairedend.xml @ 2:94f412098ac8 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit 57f71aa633a43ab02bbf05acd0c6d7f406e01f1e"
author iuc
date Thu, 28 Nov 2019 15:53:01 -0500
parents 0c9296704212
children 83fbdf93d51e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0c9296704212 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit b3426aed6615742d96dfb8f7346a9e0d4e391a99
iuc
parents: 0
diff changeset
1 <tool id="obi_illumina_pairend" name="Illuminapairedend - Assembling pair-end reads" version="@TOOL_VERSION@">
0
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
2 <description>Construct consensus reads from Illumina pair-end reads</description>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
3 <macros>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
4 <import>macros.xml</import>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
5 </macros>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
6 <expand macro="requirements"/>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
7 <expand macro="stdio"/>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
8 <command>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
9
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
10 <![CDATA[
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
11 illuminapairedend
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
12
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
13 --score-min='$score'
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
14 -r '$inputfastq3p'
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
15 '$inputfastq5p' > '$output'
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
16
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
17 ]]>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
18
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
19 </command>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
20
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
21 <inputs>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
22 <param name="inputfastq3p" type="data" format="fastq" label="Read from file" help="file of 3p (1:) Illumina pair-end reads to assemble in sanger fastq nucleic format (standard fastq)" />
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
23 <param name="inputfastq5p" type="data" format="fastq" label="Read from file" help="file of 5p (2:) Illumina pair-end reads to assemble in sanger fastq nucleic format (standard fastq)" />
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
24 <param name="score" type="float" value="40.0" label="minimum score for keeping aligment"/>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
25 </inputs>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
26 <outputs>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
27 <data format="fastq" name="output" label="${tool.name} on ${on_string}: assembly results" />
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
28 </outputs>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
29
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
30 <tests>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
31 <test>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
32 <param name="inputfastq3p" value="wolf_small.F.fastq" />
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
33 <param name="inputfastq5p" value="wolf_small.R.fastq" />
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
34 <param name="score" value="40.0" />
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
35 <output name="output" file="illuminapairedend.output.fastq" ftype="fastq"/>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
36 </test>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
37 </tests>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
38
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
39 <help><![CDATA[
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
40
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
41 .. class:: warning
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
42
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
43 **Warning:**
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
44 Sequence records corresponding to the same read pair must be in the same order in the two files
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
45
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
46 --------
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
47
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
48 .. class:: infomark
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
49
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
50 **What it does**
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
51
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
52 illuminapairedend aims at aligning the two reads of a pair-end library sequenced using an Illumina platform :
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
53
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
54 \* If the two reads overlap, it returns the consensus sequence together with its quality
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
55 \* Otherwise, it concatenates sequence merging the forward read and the reversed-complemented reverse read.
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
56
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
57 The program uses as input one or two fastq sequences reads files.
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
58
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
59 \* If two files are used one of them must be specified using the -r option. Sequence records corresponding to the same read pair must be in the same order in the two files.
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
60 \* If just one file is provided, sequence records are supposed to be all of the same length. The first half of th e sequence is used as forward read, the second half is used as the reverse read.
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
61
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
62 illuminapairedend align the forward sequence record with the reverse complement of the reverse sequence record. The alignment algorithm takes into account the base qualities.
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
63
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
64 @OBITOOLS_LINK@
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
65
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
66 ]]>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
67 </help>
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
68 <expand macro="citation" />
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
69
7275ce016923 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/obitools commit e1031e4c94b25d1ed535bf221764ab801b710ab2
iuc
parents:
diff changeset
70 </tool>