annotate tools/rgenetics/rgQC.xml @ 0:9071e359b9a3

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:37:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="rgQC1" name="QC reports:">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <description>Marker and Subject measures</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 rgQC.py -i '$input_file.extra_files_path/$input_file.metadata.base_name' -o "$title"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 -s '$html_file' -p '$html_file.files_path'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <param name="input_file" type="data" label="RGenetics genotype file in compressed Plink format"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 size="80" format="pbed" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <param name="title" size="80" type="text" value="RgQC report" label="Descriptive report title"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <data format="html" name="html_file" metadata_source="input_file" label="${title}.html"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <param name='input_file' value='tinywga' ftype='pbed' >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <metadata name='base_name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <composite_data value='tinywga.bim' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <composite_data value='tinywga.bed' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <composite_data value='tinywga.fam' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <edit_attributes type='name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name='title' value='rgQCtest1' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <output name='html_file' file='rgtestouts/rgQC/rgQCtest1.html' ftype='html' lines_diff='300'>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <param name="dbkey" value="hg18" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <extra_files type="file" name='tinywga_All_Paged.pdf' value="rgtestouts/rgQC/tinywga_All_Paged.pdf" compare="sim_size" delta = "100000"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <extra_files type="file" name='tinywga.log' value="rgtestouts/rgQC/tinywga.log" compare="diff" lines_diff="15"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <extra_files type="file" name='tinywga.frq' value="rgtestouts/rgQC/tinywga.frq" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <extra_files type="file" name='tinywga.het' value="rgtestouts/rgQC/tinywga.het" compare="diff" lines_diff="90"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <extra_files type="file" name='tinywga.hwe' value="rgtestouts/rgQC/tinywga.hwe" compare="diff" lines_diff="90"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 <extra_files type="file" name='tinywga.imendel' value="rgtestouts/rgQC/tinywga.imendel" compare="diff"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <extra_files type="file" name='tinywga.imiss' value="rgtestouts/rgQC/tinywga.imiss" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 <extra_files type="file" name='tinywga.lmendel' value="rgtestouts/rgQC/tinywga.lmendel" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 <extra_files type="file" name='tinywga.lmiss' value="rgtestouts/rgQC/tinywga.lmiss" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 <extra_files type="file" name='tinywga_All_3x3.pdf' value="rgtestouts/rgQC/tinywga_All_3x3.pdf" compare="sim_size" delta="100000"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 <extra_files type="file" name='ldp_tinywga.bed' value="rgtestouts/rgQC/ldp_tinywga.bed" compare="diff" lines_diff="10" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <extra_files type="file" name='ldp_tinywga.bim' value="rgtestouts/rgQC/ldp_tinywga.bim" compare="sim_size" delta="1000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 <extra_files type="file" name='ldp_tinywga.fam' value="rgtestouts/rgQC/ldp_tinywga.fam" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 <extra_files type="file" name='ldp_tinywga.log' value="rgtestouts/rgQC/ldp_tinywga.log" compare="diff" lines_diff="20"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 <extra_files type="file" name='Ranked_Marker_HWE.xls' value="rgtestouts/rgQC/Ranked_Marker_HWE.xls" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <extra_files type="file" name='Ranked_Marker_MAF.xls' value="rgtestouts/rgQC/Ranked_Marker_MAF.xls" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 <extra_files type="file" name='Ranked_Marker_Missing_Genotype.xls' value="rgtestouts/rgQC/Ranked_Marker_Missing_Genotype.xls" compare="diff" lines_diff="5"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 <extra_files type="file" name='Ranked_Subject_Missing_Genotype.xls' value="rgtestouts/rgQC/Ranked_Subject_Missing_Genotype.xls" compare="diff" lines_diff="40"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 <extra_files type="file" name='tinywga_fracmiss_cum.jpg' value="rgtestouts/rgQC/tinywga_fracmiss_cum.jpg" compare="sim_size" delta = "20000"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 <extra_files type="file" name='tinywga_fracmiss_cum.pdf' value="rgtestouts/rgQC/tinywga_fracmiss_cum.pdf" compare="sim_size" delta = "100000"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 </output>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 **Summary**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 This tool prepares an extensive and comprehensive series of reports for quality control checking of SNP genotypes from any arbitrary
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 genotyping experiment. Designed for family based data, so includes optional reports on Mendelian errors by
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 subject and by marker.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 The outputs include histograms and boxplots for missingness, maf, mendel counts and hwe by marker, and the ones that make sense by
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 subject. The report is built as a single web page containing links to the summary marker and subject files.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 The F (inbreeding) statistic is calculated using a somewhat LD independent group of genotypes
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 The Plink used is --indep-pairwise 40 20 0.5 until we make it configurable.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 High heterozygosity might mean contaminated sample - more than one DNA. Low heterozygosity might mean inbreeding as in strains
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 of mice.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 If the data file you want is missing from the option list above,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 you will first need to "import" it so it will be available here. Files available in the system library
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 can be imported by selecting and completing the "Import ped/map" choice from the Get Data tool group at the top of the Galaxy
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 menu. Your system administrator will be responsible for adding files to the system library.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 **Syntax**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 - **Genotype file** is the input pedfile -
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 - **Prefix** is a string used to name all of the outputs
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 **Attribution**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 This Galaxy tool was written by Ross Lazarus for the Rgenetics project
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 The current version uses Plink for most calculations and R for plotting - for full Plink attribution, source code and documentation,
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 please see http://pngu.mgh.harvard.edu/~purcell/plink/ while R attribution and source code can be found at http://r-project.org
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 Shaun Purcell provides the documentation you need specific to those settings, at
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 http://pngu.mgh.harvard.edu/~purcell/plink/anal.shtml#glm
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 Tool and Galaxy datatypes originally designed and written for the Rgenetics
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 series of whole genome scale statistical genetics tools by ross lazarus (ross.lazarus@gmail.com)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 Shaun Purcell created and maintains Plink, while a cast of many maintain R.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 Please acknowledge your use of this tool, Galaxy, R and Plink in your publications and let
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 us know so we can keep track. These tools all rely on highly competitive grant funding
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104 so your letting us know about publications is important to our ongoing support.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110 </tool>