annotate picard_NormalizeFasta.xml @ 86:c6b177fcac2e draft

Uploaded
author devteam
date Mon, 24 Feb 2014 00:32:46 -0500
parents 3115e34e348f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
77
3115e34e348f Uploaded
devteam
parents:
diff changeset
1 <tool name="NormalizeFasta" id="picard_NormalizeFasta" version="1.106.0">
3115e34e348f Uploaded
devteam
parents:
diff changeset
2 <description>Takes any file 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.</description>
3115e34e348f Uploaded
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
3115e34e348f Uploaded
devteam
parents:
diff changeset
4 <command interpreter="java -jar -Xmx8g">
3115e34e348f Uploaded
devteam
parents:
diff changeset
5 $JAVA_JAR_PATH/NormalizeFasta.jar
3115e34e348f Uploaded
devteam
parents:
diff changeset
6
3115e34e348f Uploaded
devteam
parents:
diff changeset
7 #if str( $OUTPUT ):
3115e34e348f Uploaded
devteam
parents:
diff changeset
8 OUTPUT="${OUTPUT}"
3115e34e348f Uploaded
devteam
parents:
diff changeset
9 #end if
3115e34e348f Uploaded
devteam
parents:
diff changeset
10 #if str( $LINE_LENGTH ):
3115e34e348f Uploaded
devteam
parents:
diff changeset
11 LINE_LENGTH="${LINE_LENGTH}"
3115e34e348f Uploaded
devteam
parents:
diff changeset
12 #end if
3115e34e348f Uploaded
devteam
parents:
diff changeset
13 #if str( $TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE ):
3115e34e348f Uploaded
devteam
parents:
diff changeset
14 TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE="${TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE}"
3115e34e348f Uploaded
devteam
parents:
diff changeset
15 #end if
3115e34e348f Uploaded
devteam
parents:
diff changeset
16
3115e34e348f Uploaded
devteam
parents:
diff changeset
17 VALIDATION_STRINGENCY=LENIENT
3115e34e348f Uploaded
devteam
parents:
diff changeset
18 QUIET=True
3115e34e348f Uploaded
devteam
parents:
diff changeset
19 TMP_DIR="${__new_file_path__}"
3115e34e348f Uploaded
devteam
parents:
diff changeset
20 </command>
3115e34e348f Uploaded
devteam
parents:
diff changeset
21
3115e34e348f Uploaded
devteam
parents:
diff changeset
22 <stdio>
3115e34e348f Uploaded
devteam
parents:
diff changeset
23 <exit_code range="0" level="warning" description="Tool finished correctly" />
3115e34e348f Uploaded
devteam
parents:
diff changeset
24 </stdio>
3115e34e348f Uploaded
devteam
parents:
diff changeset
25
3115e34e348f Uploaded
devteam
parents:
diff changeset
26 <inputs>
3115e34e348f Uploaded
devteam
parents:
diff changeset
27 <param name="title" label="Name for the output fasta file" type="text" default="output" />
3115e34e348f Uploaded
devteam
parents:
diff changeset
28 <param format="fasta" name="OUTPUT" type="data" label="The output fasta file to write. Required." help="" />
3115e34e348f Uploaded
devteam
parents:
diff changeset
29 <param name="LINE_LENGTH" type="integer" value="100" label="The line length to be used for the output fasta file. Default value: 100. This option can be set to 'null' to clear the default value." help="" />
3115e34e348f Uploaded
devteam
parents:
diff changeset
30 <param name="TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE" type="boolean" label="Truncate sequence names at first whitespace. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false}" help="" />
3115e34e348f Uploaded
devteam
parents:
diff changeset
31 </inputs>
3115e34e348f Uploaded
devteam
parents:
diff changeset
32 <outputs>
3115e34e348f Uploaded
devteam
parents:
diff changeset
33 <data format="fasta" name="output1" label="${title}.fasta" >
3115e34e348f Uploaded
devteam
parents:
diff changeset
34 </data>
3115e34e348f Uploaded
devteam
parents:
diff changeset
35 </outputs>
3115e34e348f Uploaded
devteam
parents:
diff changeset
36 <!-- <tests>
3115e34e348f Uploaded
devteam
parents:
diff changeset
37 <test> -->
3115e34e348f Uploaded
devteam
parents:
diff changeset
38 <!-- Here is a command line that works:
3115e34e348f Uploaded
devteam
parents:
diff changeset
39 java -jar ...
3115e34e348f Uploaded
devteam
parents:
diff changeset
40 -->
3115e34e348f Uploaded
devteam
parents:
diff changeset
41 <!-- <param name="inputFile" value="XXCHANGEMEE-input" />
3115e34e348f Uploaded
devteam
parents:
diff changeset
42 <output name="outFile" file="XXCHANGEMEE-correct-output" lines_diff="2" ftype="XXCHANGEMEE" />
3115e34e348f Uploaded
devteam
parents:
diff changeset
43 </test>
3115e34e348f Uploaded
devteam
parents:
diff changeset
44 </tests> -->
3115e34e348f Uploaded
devteam
parents:
diff changeset
45 <help>
3115e34e348f Uploaded
devteam
parents:
diff changeset
46 Picard documentation says:
3115e34e348f Uploaded
devteam
parents:
diff changeset
47
3115e34e348f Uploaded
devteam
parents:
diff changeset
48
3115e34e348f Uploaded
devteam
parents:
diff changeset
49 NormalizeFasta
3115e34e348f Uploaded
devteam
parents:
diff changeset
50
3115e34e348f Uploaded
devteam
parents:
diff changeset
51 Takes any file 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.
3115e34e348f Uploaded
devteam
parents:
diff changeset
52 Option Description
3115e34e348f Uploaded
devteam
parents:
diff changeset
53 INPUT=File The input fasta file to normalize. Required.
3115e34e348f Uploaded
devteam
parents:
diff changeset
54 OUTPUT=File The output fasta file to write. Required.
3115e34e348f Uploaded
devteam
parents:
diff changeset
55 LINE_LENGTH=Integer The line length to be used for the output fasta file. Default value: 100. This option can be set to 'null' to clear the default value.
3115e34e348f Uploaded
devteam
parents:
diff changeset
56 TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE=Boolean Truncate sequence names at first whitespace. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false}
3115e34e348f Uploaded
devteam
parents:
diff changeset
57
3115e34e348f Uploaded
devteam
parents:
diff changeset
58
3115e34e348f Uploaded
devteam
parents:
diff changeset
59 </help>
3115e34e348f Uploaded
devteam
parents:
diff changeset
60 </tool>