annotate picard_NormalizeFasta.xml @ 14:465cbb0cf2eb draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
author devteam
date Wed, 07 Dec 2016 14:56:30 -0500
parents 7e6fd3d0f16e
children 5053a18d9bc8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
1 <tool name="NormalizeFasta" id="picard_NormalizeFasta" version="@TOOL_VERSION@.0">
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>normalize fasta datasets</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </macros>
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
6 <expand macro="requirements" />
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 @java_options@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
9
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
10 ## Two lines below are due to the fact that picard likes fasta files to have extension .fa
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
11 #import re
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
12 #set escaped_element_identifier = re.sub('[^\w\-]', '_', str($inputFile.element_identifier))
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
13 ln -f -s '$inputFile' '$escaped_element_identifier'.fa &&
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
14 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 NormalizeFasta
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
16
14
465cbb0cf2eb planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 74ee0f0b594075fab7f707aaffb4a7f9dac35f2f
devteam
parents: 13
diff changeset
17 INPUT='$escaped_element_identifier'.fa
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 LINE_LENGTH="${line_length}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE="${truncate_sequence_names_at_whitespaces}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
21
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 VERBOSITY=ERROR
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
24
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 8
diff changeset
25 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 <param format="fasta" name="inputFile" type="data" label="FASTA dataset or dataset collection" help="If empty, upload or import a FASTA dataset" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 <param name="line_length" type="integer" value="100" min="1" max="200" label="The line length to be used for the output fasta file" help="LINE_LENGTH; default=100"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 <param name="truncate_sequence_names_at_whitespaces" type="boolean" label="Truncate sequence names at first whitespace" help="TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE; default=False"/>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
30 </inputs>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
31
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 <data format="fasta" name="outFile" label="${tool.name} on ${on_string}: Normalized FASTA dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
35
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 <param name="inputFile" value="picard_NormalizeFasta_ref.fa" ftype="fasta"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 <param name="line_length" value="40"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 <param name="truncate_sequence_names_at_whitespaces" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 <output name="outFile" file="picard_NormalizeFasta_test1.fa" ftype="fasta"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
44
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
45
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 Takes any dataset that conforms to the fasta format and normalizes it so that all lines of sequence except the last line per named sequence are of the same length.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
56 LINE_LENGTH=Integer The line length to be used for the output fasta file. Default value: 100.
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
57
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
59 Truncate sequence names at first whitespace. Default value: false. Possible values: {true, false}
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66