annotate picard_NormalizeFasta.xml @ 0:5166ed57b1c4 draft

Uploaded version 1.135
author avowinkel
date Mon, 06 Jul 2015 14:46:32 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
1 <tool name="NormalizeFasta" id="picard_NormalizeFasta" version="1.135">
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
2 <description>normalize fasta datasets</description>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
3 <macros>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
4 <import>picard_macros.xml</import>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
5 </macros>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
6 <expand macro="requirements" />
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
7 <command>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
8 @java_options@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
9
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
10
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
11 ## Two lines below are due to the fact that picard likes fasta files to have extension .fa
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
12 #set $fasta_file="local_fasta.fa"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
13 ln -s "${inputFile}" "${fasta_file}" &amp;&amp;
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
14
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
15 java -jar \$JAVA_JAR_PATH/picard.jar
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
16 NormalizeFasta
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
17
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
18 INPUT="${fasta_file}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
19 OUTPUT="${outFile}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
20 LINE_LENGTH="${line_length}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
21 TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE="${truncate_sequence_names_at_whitespaces}"
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
22
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
23 QUIET=true
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
24 VERBOSITY=ERROR
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
25
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
26 </command>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
27 <inputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
28 <param format="fasta" name="inputFile" type="data" label="FASTA dataset or dataset collection" help="If empty, upload or import a FASTA dataset" />
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
29 <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"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
30 <param name="truncate_sequence_names_at_whitespaces" type="boolean" label="Truncate sequence names at first whitespace" help="TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE; default=False"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
31 </inputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
32
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
33 <outputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
34 <data format="fasta" name="outFile" label="${tool.name} on ${on_string}: Normalized FASTA dataset"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
35 </outputs>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
36
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
37 <tests>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
38 <test>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
39 <param name="inputFile" value="picard_NormalizeFasta_ref.fa" ftype="fasta"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
40 <param name="line_length" value="40"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
41 <param name="truncate_sequence_names_at_whitespaces" value="False"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
42 <output name="outFile" file="picard_NormalizeFasta_test1.fa" ftype="fasta"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
43 </test>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
44 </tests>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
45
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
46 <stdio>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
47 <exit_code range="1:" level="fatal"/>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
48 </stdio>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
49
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
50 <help>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
51
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
52 **Purpose**
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
53
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
54 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.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
55
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
56 @dataset_collections@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
57
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
58 @description@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
59
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
60 LINE_LENGTH=Integer The line length to be used for the output fasta file. Default value: 100.
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
61
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
62 TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE=Boolean
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
63 Truncate sequence names at first whitespace. Default value: false. Possible values: {true, false}
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
64
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
65 @more_info@
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
66
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
67 </help>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
68 </tool>
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
69
5166ed57b1c4 Uploaded version 1.135
avowinkel
parents:
diff changeset
70