annotate tools/rgenetics/rgGRR.xml @ 2:c2a356708570

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:45:42 -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="rgGRR1" name="GRR:">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>Pairwise Allele Sharing</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 rgGRR.py $i.extra_files_path/$i.metadata.base_name "$i.metadata.base_name"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 '$out_file1' '$out_file1.files_path' "$title" '$n' '$Z'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 <param name="i" type="data" label="Genotype data file from your current history"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 format="ldindep" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <param name='title' type='text' size="80" value='rgGRR' label="Title for this job"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <param name="n" type="integer" label="N snps to use (0=all)" value="5000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <param name="Z" type="float" label="Z score cutoff for outliers (eg 2)" value="6"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 help="2 works but for very large numbers of pairs, you might want to see less than 5%" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <data format="html" name="out_file1" label="${title}_rgGRR.html"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <param name='i' value='tinywga' ftype='ldindep' >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <metadata name='base_name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <composite_data value='tinywga.bim' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <composite_data value='tinywga.bed' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <composite_data value='tinywga.fam' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <edit_attributes type='name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <param name='title' value='rgGRRtest1' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name='n' value='100' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name='Z' value='6' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <param name='force' value='true' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <output name='out_file1' file='rgtestouts/rgGRR/rgGRRtest1.html' ftype='html' compare="diff" lines_diff='350'>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <extra_files type="file" name='Log_rgGRRtest1.txt' value="rgtestouts/rgGRR/Log_rgGRRtest1.txt" compare="diff" lines_diff="170"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <extra_files type="file" name='rgGRRtest1.svg' value="rgtestouts/rgGRR/rgGRRtest1.svg" compare="diff" lines_diff="1000" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <extra_files type="file" name='rgGRRtest1_table.xls' value="rgtestouts/rgGRR/rgGRRtest1_table.xls" compare="diff" lines_diff="100" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 </output>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 **Explanation**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 This tool will calculate allele sharing among all subjects, one pair at a time. It outputs measures of average alleles
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 shared and measures of variability for each pair of subjects and creates an interactive image where each pair is
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 plotted in this mean/variance space. It is based on the GRR windows application available at
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 http://www.sph.umich.edu/csg/abecasis/GRR/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 The plot is interactive - you can unselect one of the relationships in the legend to remove all those points
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 from the plot for example. Details of outlier pairs will pop up when the pointer is over them. e found by moving your pointer
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 over them. This relies on a working browser SVG plugin - try getting one installed for your browser if the interactivity is
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 broken.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 **Syntax**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 - **Genotype file** is the input pedigree data chosen from available library Plink binary files
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 - **Title** will be used to name the outputs so make it mnemonic and useful
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 - **N** is left 0 to use all snps - otherwise you get a random sample - much quicker with little loss of precision > 5000 SNPS
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 **Summary**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 Warning - this tool works pairwise so slows down exponentially with sample size. An LD-reduced dataset is
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 strongly recommended as it will give good resolution with relatively few SNPs. Do not use all million snps from a whole
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 genome chip - it's overkill - 5k is good, 10k is almost indistinguishable from 100k.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 SNP are sampled randomly from the autosomes - otherwise parent/child pairs will be separated by gender.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 This tool will estimate mean pairwise allele shareing among all subjects. Based on the work of Abecasis, it has
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 been rewritten so it can run with much larger data sets, produces cross platform svg and runs
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 on a Galaxy server, instead of being MS windows only. Written in is Python, it uses numpy, and the innermost loop
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 is inline C so it can calculate about 50M SNPpairs/sec on a typical opteron server.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 Setting N to some (fraction) of available markers will speed up calculation - the difference is most painful for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 large subject N. The real cost is that every subject must be compared to every other one over all genotypes -
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 this is an exponential problem on subjects.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 If you don't see the genotype data set you want here, it can be imported using one of the methods available from
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 the Rgenetics Get Data tool.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 **Attribution**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 Based on an idea from G. Abecasis implemented as GRR (windows only) at http://www.sph.umich.edu/csg/abecasis/GRR/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 Ross Lazarus wrote the original pdf writer Galaxy tool version.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 John Ziniti added the C and created the slick svg representation.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 Copyright Ross Lazarus 2007
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 Licensed under the terms of the LGPL as documented http://www.gnu.org/licenses/lgpl.html
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 </tool>