annotate picard_NormalizeFasta.xml @ 71:2e90d8b7dfa7 draft

Uploaded
author devteam
date Wed, 19 Feb 2014 17:59:27 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
71
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
1 <tool name="NormalizeFasta" id="picard_NormalizeFasta" version="1.106.0">
2e90d8b7dfa7 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>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
4 <command interpreter="java -jar -Xmx8g">
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
5 $JAVA_JAR_PATH/NormalizeFasta.jar
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
6
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
7 #if str( $OUTPUT ):
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
8 OUTPUT="${OUTPUT}"
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
9 #end if
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
10 #if str( $LINE_LENGTH ):
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
11 LINE_LENGTH="${LINE_LENGTH}"
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
12 #end if
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
13 #if str( $TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE ):
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
14 TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE="${TRUNCATE_SEQUENCE_NAMES_AT_WHITESPACE}"
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
15 #end if
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
16
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
17 VALIDATION_STRINGENCY=LENIENT
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
18 QUIET=True
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
19 TMP_DIR="${__new_file_path__}"
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
20 </command>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
21
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
22 <stdio>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
23 <exit_code range="0" level="warning" description="Tool finished correctly" />
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
24 </stdio>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
25
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
26 <inputs>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
27 <param format="XXCHANGEMEEE" name="OUTPUT" type="data" label="The output fasta file to write. Required." help="" />
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
28 <param format="XXCHANGEMEEE" name="LINE_LENGTH" type="string" 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="" />
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
29 <param format="XXCHANGEMEEE" 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="" />
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
30 </inputs>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
31 <outputs>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
32 <data name="outFile" format="XXCHANGEMEEE">
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
33 </data>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
34 </outputs>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
35 <tests>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
36 <test>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
37 <!-- Here is a command line that works:
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
38 java -jar ...
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
39 -->
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
40 <param name="inputFile" value="XXCHANGEMEE-input" />
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
41 <output name="outFile" file="XXCHANGEMEE-correct-output" lines_diff="2" ftype="XXCHANGEMEE" />
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
42 </test>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
43 </tests>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
44 <help>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
45 Picard documentation says:
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
46
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
47
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
48 NormalizeFasta
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
49
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
50 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.
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
51 Option Description
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
52 INPUT=File The input fasta file to normalize. Required.
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
53 OUTPUT=File The output fasta file to write. Required.
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
54 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.
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
55 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}
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
56
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
57
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
58 </help>
2e90d8b7dfa7 Uploaded
devteam
parents:
diff changeset
59 </tool>