annotate picard_NormalizeFasta.xml @ 6:4ff1e04010e6 draft

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