annotate analyze_covariates.xml @ 1:1d427770e7ec draft

Uploaded tool wrapper XML with correct specification of java .jar path.
author devteam
date Wed, 02 Apr 2014 15:21:06 -0400
parents be6bede22459
children 738bc749f9a3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="gatk_analyze_covariates" name="Analyze Covariates" version="0.0.5">
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
2 <description>- draw plots</description>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
3 <requirements>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
4 <requirement type="package" version="1.4">gatk</requirement>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
5 </requirements>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
6 <macros>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
7 <import>gatk_macros.xml</import>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
8 </macros>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
9 <command interpreter="python">gatk_wrapper.py
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
10 --max_jvm_heap_fraction "1"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
11 --stdout "${output_log}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
12 --html_report_from_directory "${output_html}" "${output_html.files_path}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
13 -p 'java
1
1d427770e7ec Uploaded tool wrapper XML with correct specification of java .jar path.
devteam
parents: 0
diff changeset
14 -jar "\$JAVA_JAR_PATH/AnalyzeCovariates.jar"
0
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
15 -recalFile "${input_recal}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
16 -outputDir "${output_html.files_path}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
17 ##--num_threads 4 ##hard coded, for now
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
18 ##-log "${output_log}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
19 ##-Rscript,--path_to_Rscript path_to_Rscript; on path is good enough
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
20 #if $analysis_param_type.analysis_param_type_selector == "advanced":
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
21 --ignoreQ "${analysis_param_type.ignore_q}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
22 --numRG "${analysis_param_type.num_read_groups}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
23 --max_quality_score "${analysis_param_type.max_quality_score}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
24 --max_histogram_value "${analysis_param_type.max_histogram_value}"
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
25 ${analysis_param_type.do_indel_quality}
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
26 #end if
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
27 '
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
28 </command>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
29 <inputs>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
30 <param name="input_recal" type="data" format="csv" label="Covariates table recalibration file" help="-recalFile,--recal_file &amp;lt;recal_file&amp;gt;" />
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
31 <conditional name="analysis_param_type">
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
32 <param name="analysis_param_type_selector" type="select" label="Basic or Advanced options">
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
33 <option value="basic" selected="True">Basic</option>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
34 <option value="advanced">Advanced</option>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
35 </param>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
36 <when value="basic">
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
37 <!-- Do nothing here -->
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
38 </when>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
39 <when value="advanced">
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
40 <param name="ignore_q" type="integer" value="5" label="Ignore bases with reported quality less than this number." help="-ignoreQ,--ignoreQ &amp;lt;ignoreQ&amp;gt; "/>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
41 <param name="num_read_groups" type="integer" value="-1" label="Only process N read groups." help="-numRG,--numRG &amp;lt;numRG&amp;gt;"/>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
42 <param name="max_quality_score" type="integer" value="50" label="Max quality score" help="-maxQ,--max_quality_score &amp;lt;max_quality_score&amp;gt;"/>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
43 <param name="max_histogram_value" type="integer" value="0" label="Max histogram value" help="-maxHist,--max_histogram_value &amp;lt;max_histogram_value&amp;gt;"/>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
44 <param name="do_indel_quality" type="boolean" truevalue="--do_indel_quality" falsevalue="" label="Do indel quality" help="--do_indel_quality"/>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
45 </when>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
46 </conditional>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
47 </inputs>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
48 <outputs>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
49 <data format="html" name="output_html" label="${tool.name} on ${on_string} (HTML)" />
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
50 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
51 </outputs>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
52 <tests>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
53 <test>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
54 <param name="input_recal" value="gatk/gatk_count_covariates/gatk_count_covariates_out_1.csv" ftype="csv" />
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
55 <param name="analysis_param_type_selector" value="basic" />
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
56 <output name="output_html" file="gatk/gatk_analyze_covariates/gatk_analyze_covariates_out_1.html" />
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
57 <output name="output_log" file="gatk/gatk_analyze_covariates/gatk_analyze_covariates_out_1.log.contains" compare="contains" />
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
58 </test>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
59 </tests>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
60 <help>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
61 **What it does**
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
62
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
63 Create collapsed versions of the recal csv file and call R scripts to plot residual error versus the various covariates.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
64
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
65 For more information on base quality score recalibration using the GATK, see this `tool specific page &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Base_quality_score_recalibration&gt;`_.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
66
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
67 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Best_Practice_Variant_Detection_with_the_GATK_v3&gt;`_.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
68
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
69 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Frequently_Asked_Questions&gt;`_.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
70
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
71 ------
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
72
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
73 **Inputs**
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
74
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
75 GenomeAnalysisTK: AnalyzeCovariates accepts an recal CSV file.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
76
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
77
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
78 **Outputs**
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
79
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
80 The output is in CSV and HTML files with links to PDF graphs and a data files.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
81
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
82
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
83 Go `here &lt;http://www.broadinstitute.org/gsa/wiki/index.php/Input_files_for_the_GATK&gt;`_ for details on GATK file formats.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
84
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
85 -------
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
86
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
87 **Settings**::
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
88
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
89 recal_file The input recal csv file to analyze
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
90 output_dir The directory in which to output all the plots and intermediate data files
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
91 path_to_Rscript The path to your implementation of Rscript. For Broad users this is maybe /broad/tools/apps/R-2.6.0/bin/Rscript
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
92 path_to_resources Path to resources folder holding the Sting R scripts.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
93 ignoreQ Ignore bases with reported quality less than this number.
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
94 numRG Only process N read groups. Default value: -1 (process all read groups)
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
95 max_quality_score The integer value at which to cap the quality scores, default is 50
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
96 max_histogram_value If supplied, this value will be the max value of the histogram plots
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
97 do_indel_quality If supplied, this value will be the max value of the histogram plots
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
98
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
99 @CITATION_SECTION@
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
100 </help>
be6bede22459 Imported from capsule None
devteam
parents:
diff changeset
101 </tool>