annotate picard_MeanQualityByCycle.xml @ 153:5d881472c379 draft default tip

mm
author Rayan Chikhi <chikhi@psu.edu>
date Mon, 21 Jul 2014 16:36:03 -0400
parents b7f09b994fd0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
125
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
1 <tool name="MeanQualityByCycle" id="picard_MeanQualityByCycle" version="1.106.0">
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
2 <description>Calculates mean quality by cycle</description>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
4 <command interpreter="python">
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
5 picard_wrapper.py -i "${input_file}" -d "${html_file.files_path}" -t "${html_file}"
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
6 -n "${out_prefix}" --tmpdir "${__new_file_path__}" --assumesorted ${ASSUME_SORTED}
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
7 --pfreadsonly ${PF_READS_ONLY} --alignedreadsonly ${ALIGNED_READS_ONLY}
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
8 -j "\$JAVA_JAR_PATH/MeanQualityByCycle.jar"
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
9 </command>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
10
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
11 <stdio>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
12 <exit_code range="0" level="warning" description="Tool finished correctly" />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
13 </stdio>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
14
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
15 <inputs>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
16 <param format="sam,bam" name="input_file" type="data" label="Input SAM or BAM file. Required." help="" />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
17 <param checked="False" truevalue="true" falsevalue="false" name="ALIGNED_READS_ONLY" type="boolean" label="If set to true, calculate mean quality over aligned reads only." help="" />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
18 <param checked="False" truevalue="true" falsevalue="false" name="PF_READS_ONLY" type="boolean" label="If set to true calculate mean quality over PF reads only." help="" />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
19 <param checked="True" truevalue="true" falsevalue="false" name="ASSUME_SORTED" type="boolean" label="If true (default), then the sort order in the header file will be ignored." />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
20 <param name="out_prefix" value="Mean quality by cycle" type="text"
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
21 label="Title for the output file" help="Use this remind you what the job was for." size="80" />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
22 </inputs>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
23 <outputs>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
24 <data format="html" name="html_file" label="${out_prefix}.html"/>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
25 </outputs>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
26 <tests>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
27 <test>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
28 <!-- Here is a command line that works:
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
29 java -jar ...
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
30 -->
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
31 <!--
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
32 <param name="inputFile" value="XXCHANGEMEE-input" />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
33 <output name="outFile" file="XXCHANGEMEE-correct-output" lines_diff="2" ftype="XXCHANGEMEE" />
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
34 -->
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
35 </test>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
36 </tests>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
37 <help>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
38 Picard documentation says:
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
39
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
40
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
41 MeanQualityByCycle
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
42
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
43 Usage: program [options...]
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
44
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
45 Option Description
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
46 CHART_OUTPUT=File A file (with .pdf extension) to write the chart to. Required.
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
47 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}
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
48 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}
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
49 INPUT=File Input SAM or BAM file. Required.
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
50 OUTPUT=File File to write the output to. Required.
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
51 REFERENCE_SEQUENCE=File Reference sequence fasta Default value: null. // Actually, this does not seem to be used anywhere in the tool -- so we removed it
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
52 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}
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
53 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.
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
54
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
55
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
56 </help>
b7f09b994fd0 Uploaded
devteam
parents:
diff changeset
57 </tool>