annotate tools/rgenetics/rgCaCo.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="rgCaCo1" name="Case Control:">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>for unrelated subjects</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 rgCaCo.py '$i.extra_files_path/$i.metadata.base_name' "$title" '$out_file1' '$logf' '$logf.files_path' '$gffout'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <param name="i" type="data" label="RGenetics genotype data from your current history"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 format="pbed" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <param name='title' type='text' size="132" value='CaseControl' label="Title for this job"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <data format="tabular" name="out_file1" label="${title}_rgCaCo.xls" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <data format="txt" name="logf" label="${title}_rgCaCo.log"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <data format="gff" name="gffout" label="${title}_rgCaCoTop.gff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <param name='i' value='tinywga' ftype='pbed' >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <metadata name='base_name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <composite_data value='tinywga.bim' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <composite_data value='tinywga.bed' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <composite_data value='tinywga.fam' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <edit_attributes type='name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <param name='title' value='rgCaCotest1' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <output name='out_file1' file='rgCaCotest1_CaCo.xls' ftype='tabular' compare='diff' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <output name='logf' file='rgCaCotest1_CaCo_log.txt' ftype='txt' compare='diff' lines_diff='20' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <output name='gffout' file='rgCaCotest1_CaCo_topTable.gff' ftype='gff' compare='diff' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 **Syntax**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 - **Genotype file** is the input case control data chosen from available library Plink binary files
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 - **Map file** is the linkage format .map file corresponding to the genotypes in the Genotype file
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 - **Type of test** is the kind of test statistic to report such as Armitage trend test or genotype test
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 - **Format** determines how your data will be returned to your Galaxy workspace
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 **Summary**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 This tool will perform some standard statistical tests comparing subjects designated as
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 affected (cases) and unaffected subjects (controls). To avoid bias, it is important that
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 controls who had been affected would have been eligible for sampling as cases. This may seem
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 odd, but it requires that the cases and controls are drawn from the same sampling frame.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 The armitage trend test is robust to departure from HWE and so very attractive - after all, a real disease
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 mutation may well result in distorted HWE at least in cases. All the others are susceptible to
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 bias in the presence of HWE departures.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 All of these tests are exquisitely sensitive to non-differential population stratification in cases
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 compared to controls and this must be tested before believing any results here. Use the PCA method for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 100k markers or more.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 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
62 the Galaxy Get Data tool page.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 Output format can be UCSC .bed if you want to see your
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 results as a fully fledged UCSC track. A map file containing the chromosome and offset for each marker is required for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 writing this kind of output.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 Alternatively you can use .gg for the UCSC Genome Graphs tool which has all of the advantages
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 of the the .bed track, plus a neat, visual front end that displays a lot of useful clues.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 Either of these are a very useful way of quickly getting a look
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 at your data in full genomic context.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 Finally, if you can't live without
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 spreadsheet data, choose the .xls tab delimited format. It's not a stupid binary excel file. Just a plain old tab delimited
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 one with a header. Fortunately excel is dumb enough to open these without much protest.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75
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 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 **Attribution**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 This Galaxy tool relies on Plink (see Plinksrc_) to test Casae Control association models.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 So, we rely on the author (Shaun Purcell) for the documentation you need specific to those settings - they are very nicely documented - see
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 DOC_
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 Tool and Galaxy datatypes originally designed and written for the Rgenetics
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89 series of whole genome scale statistical genetics tools by ross lazarus (ross.lazarus@gmail.com)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 Copyright Ross Lazarus March 2007
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92 This Galaxy wrapper is released licensed under the LGPL_ but is about as useful as a chocolate teapot without Plink which is GPL.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 I'm no lawyer, but it looks like you got GPL if you use this software. Good luck.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 .. _Plinksrc: http://pngu.mgh.harvard.edu/~purcell/plink/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98 .. _LGPL: http://www.gnu.org/copyleft/lesser.html
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100 .. _DOC: http://pngu.mgh.harvard.edu/~purcell/plink/anal.shtml#cc
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 </tool>