annotate tools/gatk/analyze_covariates.xml @ 1:cdcb0ce84a1b

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:15 -0500
parents 9071e359b9a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="gatk_analyze_covariates" name="Analyze Covariates" version="0.0.1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>- perform local realignment</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">gatk_wrapper.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 --stdout "${output_log}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 --html_report_from_directory "${output_html}" "${output_html.files_path}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 -p 'java
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 -jar "${GALAXY_DATA_INDEX_DIR}/shared/jars/gatk/AnalyzeCovariates.jar"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 -recalFile "${input_recal}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 -outputDir "${output_html.files_path}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 ##-log "${output_log}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 ##-Rscript,--path_to_Rscript path_to_Rscript; on path is good enough
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 -resources "${GALAXY_DATA_INDEX_DIR}/gatk/R"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 #if $analysis_param_type.analysis_param_type_selector == "advanced":
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 --ignoreQ "${analysis_param_type.ignore_q}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 --numRG "${analysis_param_type.num_read_groups}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 --max_quality_score "${analysis_param_type.max_quality_score}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 --max_histogram_value "${analysis_param_type.max_histogram_value}"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 ${analysis_param_type.do_indel_quality}
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 #end if
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 '
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <param name="input_recal" type="data" format="csv" label="Covariates table recalibration file" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <conditional name="analysis_param_type">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <param name="analysis_param_type_selector" type="select" label="Basic or Advanced options">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <option value="basic" selected="True">Basic</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <option value="advanced">Advanced</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <when value="basic">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <!-- Do nothing here -->
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <when value="advanced">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <param name="ignore_q" type="integer" value="5" label="Ignore bases with reported quality less than this number."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <param name="num_read_groups" type="integer" value="-1" label="Only process N read groups."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <param name="max_quality_score" type="integer" value="50" label="Max quality score"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <param name="max_histogram_value" type="integer" value="0" label="Max quality score"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 <param name="do_indel_quality" type="boolean" truevalue="--do_indel_quality" falsevalue="" label="Max quality score"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 </when>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 </conditional>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <data format="html" name="output_html" label="${tool.name} on ${on_string} (HTML)" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <param name="input_recal" value="gatk/gatk_count_covariates/gatk_count_covariates_out_1.csv" ftype="csv" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <param name="analysis_param_type_selector" value="basic" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 <output name="output_html" file="gatk/gatk_analyze_covariates/gatk_analyze_covariates_out_1.html" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 <output name="output_log" file="gatk/gatk_analyze_covariates/gatk_analyze_covariates_out_1.log.contains" compare="contains" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 Create collapsed versions of the recal csv file and call R scripts to plot residual error versus the various covariates.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 Please cite the website "http://addlink.here" as well as:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 Add citation here 2011.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 **Input formats**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 GenomeAnalysisTK: AnalyzeCovariates accepts an recal CSV file.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 ------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 **Outputs**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 The output is in and HTML file with links to PDF graphs and a data files, see http://addlink.here for more details.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 -------
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 **Settings**::
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 recal_file The input recal csv file to analyze
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 output_dir The directory in which to output all the plots and intermediate data files
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 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
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 path_to_resources Path to resources folder holding the Sting R scripts.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 ignoreQ Ignore bases with reported quality less than this number.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 numRG Only process N read groups. Default value: -1 (process all read groups)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 max_quality_score The integer value at which to cap the quality scores, default is 50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 max_histogram_value If supplied, this value will be the max value of the histogram plots
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 do_indel_quality If supplied, this value will be the max value of the histogram plots
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 </tool>