annotate picard_MeanQualityByCylce.xml @ 118:21bf2afb895c draft

Uploaded
author devteam
date Tue, 25 Feb 2014 18:55:09 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
118
21bf2afb895c Uploaded
devteam
parents:
diff changeset
1 <tool name="MeanQualityByCycle" id="picard_MeanQualityByCycle" version="1.106.0">
21bf2afb895c Uploaded
devteam
parents:
diff changeset
2 <description>Calculates mean quality</description>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
4 <command interpreter="bash">
21bf2afb895c Uploaded
devteam
parents:
diff changeset
5 <!-- generic_outformat_wrapper.sh MeanQualityByCycle $outFile $outputFormat
21bf2afb895c Uploaded
devteam
parents:
diff changeset
6 CHART_OUTPUT=File A file (with .pdf extension) to write the chart to. Required.
21bf2afb895c Uploaded
devteam
parents:
diff changeset
7
21bf2afb895c Uploaded
devteam
parents:
diff changeset
8 #if str( $ALIGNED_READS_ONLY ):
21bf2afb895c Uploaded
devteam
parents:
diff changeset
9 ALIGNED_READS_ONLY="${ALIGNED_READS_ONLY}"
21bf2afb895c Uploaded
devteam
parents:
diff changeset
10 #end if
21bf2afb895c Uploaded
devteam
parents:
diff changeset
11 #if str( $PF_READS_ONLY ):
21bf2afb895c Uploaded
devteam
parents:
diff changeset
12 PF_READS_ONLY="${PF_READS_ONLY}"
21bf2afb895c Uploaded
devteam
parents:
diff changeset
13 #end if
21bf2afb895c Uploaded
devteam
parents:
diff changeset
14 #if str( $INPUT ):
21bf2afb895c Uploaded
devteam
parents:
diff changeset
15 INPUT="${INPUT}"
21bf2afb895c Uploaded
devteam
parents:
diff changeset
16 #end if
21bf2afb895c Uploaded
devteam
parents:
diff changeset
17 #if str( $OUTPUT ):
21bf2afb895c Uploaded
devteam
parents:
diff changeset
18 OUTPUT="${OUTPUT}"
21bf2afb895c Uploaded
devteam
parents:
diff changeset
19 #end if
21bf2afb895c Uploaded
devteam
parents:
diff changeset
20 #if str( $REFERENCE_SEQUENCE ):
21bf2afb895c Uploaded
devteam
parents:
diff changeset
21 REFERENCE_SEQUENCE="${REFERENCE_SEQUENCE}"
21bf2afb895c Uploaded
devteam
parents:
diff changeset
22 #end if
21bf2afb895c Uploaded
devteam
parents:
diff changeset
23 #if str( $ASSUME_SORTED ):
21bf2afb895c Uploaded
devteam
parents:
diff changeset
24 ASSUME_SORTED="${ASSUME_SORTED}"
21bf2afb895c Uploaded
devteam
parents:
diff changeset
25 #end if
21bf2afb895c Uploaded
devteam
parents:
diff changeset
26 #if str( $STOP_AFTER ):
21bf2afb895c Uploaded
devteam
parents:
diff changeset
27 STOP_AFTER="${STOP_AFTER}"
21bf2afb895c Uploaded
devteam
parents:
diff changeset
28 #end if
21bf2afb895c Uploaded
devteam
parents:
diff changeset
29
21bf2afb895c Uploaded
devteam
parents:
diff changeset
30 VALIDATION_STRINGENCY=LENIENT
21bf2afb895c Uploaded
devteam
parents:
diff changeset
31 QUIET=True
21bf2afb895c Uploaded
devteam
parents:
diff changeset
32 TMP_DIR="${__new_file_path__}" -->
21bf2afb895c Uploaded
devteam
parents:
diff changeset
33 </command>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
34
21bf2afb895c Uploaded
devteam
parents:
diff changeset
35 <stdio>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
36 <exit_code range="0" level="warning" description="Tool finished correctly" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
37 </stdio>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
38
21bf2afb895c Uploaded
devteam
parents:
diff changeset
39 <inputs>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
40 <!--
21bf2afb895c Uploaded
devteam
parents:
diff changeset
41 <param format="XXCHANGEMEEE" name="ALIGNED_READS_ONLY" type="boolean" label="If set to true, calculate mean quality over aligned reads only. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false}" help="" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
42 <param format="XXCHANGEMEEE" name="PF_READS_ONLY" type="boolean" label="If set to true calculate mean quality over PF reads only. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false}" help="" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
43 <param format="XXCHANGEMEEE" name="INPUT" type="data" label="Input SAM or BAM file. Required." help="" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
44 <param format="XXCHANGEMEEE" name="OUTPUT" type="data" label="File to write the output to. Required." help="" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
45 <param format="XXCHANGEMEEE" name="REFERENCE_SEQUENCE" type="data" label="Reference sequence fasta Default value: null." help="" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
46 <param format="XXCHANGEMEEE" name="ASSUME_SORTED" type="boolean" label="If true (default), then the sort order in the header file will be ignored. Default value: true. This option can be set to 'null' to clear the default value. Possible values: {true, false}" help="" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
47 <param format="XXCHANGEMEEE" name="STOP_AFTER" type="string" label="Stop after processing N reads, mainly for debugging. Default value: 0. This option can be set to 'null' to clear the default value." help="" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
48 -->
21bf2afb895c Uploaded
devteam
parents:
diff changeset
49 </inputs>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
50 <outputs>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
51 <!--
21bf2afb895c Uploaded
devteam
parents:
diff changeset
52 <data name="outFile" format="XXCHANGEMEEE">
21bf2afb895c Uploaded
devteam
parents:
diff changeset
53
21bf2afb895c Uploaded
devteam
parents:
diff changeset
54 </data>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
55 -->
21bf2afb895c Uploaded
devteam
parents:
diff changeset
56 </outputs>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
57 <tests>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
58 <test>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
59 <!-- Here is a command line that works:
21bf2afb895c Uploaded
devteam
parents:
diff changeset
60 java -jar ...
21bf2afb895c Uploaded
devteam
parents:
diff changeset
61 -->
21bf2afb895c Uploaded
devteam
parents:
diff changeset
62 <!--
21bf2afb895c Uploaded
devteam
parents:
diff changeset
63 <param name="inputFile" value="XXCHANGEMEE-input" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
64 <output name="outFile" file="XXCHANGEMEE-correct-output" lines_diff="2" ftype="XXCHANGEMEE" />
21bf2afb895c Uploaded
devteam
parents:
diff changeset
65 -->
21bf2afb895c Uploaded
devteam
parents:
diff changeset
66 </test>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
67 </tests>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
68 <help>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
69 Picard documentation says:
21bf2afb895c Uploaded
devteam
parents:
diff changeset
70
21bf2afb895c Uploaded
devteam
parents:
diff changeset
71
21bf2afb895c Uploaded
devteam
parents:
diff changeset
72 MeanQualityByCycle
21bf2afb895c Uploaded
devteam
parents:
diff changeset
73
21bf2afb895c Uploaded
devteam
parents:
diff changeset
74 Usage: program [options...]
21bf2afb895c Uploaded
devteam
parents:
diff changeset
75
21bf2afb895c Uploaded
devteam
parents:
diff changeset
76 Option Description
21bf2afb895c Uploaded
devteam
parents:
diff changeset
77 CHART_OUTPUT=File A file (with .pdf extension) to write the chart to. Required.
21bf2afb895c Uploaded
devteam
parents:
diff changeset
78 ALIGNED_READS_ONLY=Boolean If set to true, calculate mean quality over aligned reads only. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false}
21bf2afb895c Uploaded
devteam
parents:
diff changeset
79 PF_READS_ONLY=Boolean If set to true calculate mean quality over PF reads only. Default value: false. This option can be set to 'null' to clear the default value. Possible values: {true, false}
21bf2afb895c Uploaded
devteam
parents:
diff changeset
80 INPUT=File Input SAM or BAM file. Required.
21bf2afb895c Uploaded
devteam
parents:
diff changeset
81 OUTPUT=File File to write the output to. Required.
21bf2afb895c Uploaded
devteam
parents:
diff changeset
82 REFERENCE_SEQUENCE=File Reference sequence fasta Default value: null.
21bf2afb895c Uploaded
devteam
parents:
diff changeset
83 ASSUME_SORTED=Boolean If true (default), then the sort order in the header file will be ignored. Default value: true. This option can be set to 'null' to clear the default value. Possible values: {true, false}
21bf2afb895c Uploaded
devteam
parents:
diff changeset
84 STOP_AFTER=Long Stop after processing N reads, mainly for debugging. Default value: 0. This option can be set to 'null' to clear the default value.
21bf2afb895c Uploaded
devteam
parents:
diff changeset
85
21bf2afb895c Uploaded
devteam
parents:
diff changeset
86
21bf2afb895c Uploaded
devteam
parents:
diff changeset
87 </help>
21bf2afb895c Uploaded
devteam
parents:
diff changeset
88 </tool>