annotate picard_NormalizeFasta.xml @ 73:aab71b7ea084 draft

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