annotate tools/rgenetics/rgTDT.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="rgTDT1" name="Transmission Distortion:">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>for family data</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 rgTDT.py -i '$i.extra_files_path/$i.metadata.base_name' -o '$title'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 -r '$out_file1' -l '$logf' -g '$gffout'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <param name="i" type="data" label="Genotypes for analysis from your current history datasets"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 size="132" format="pbed" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <param name='title' type='text' value='rgTDT' label="Title for the output to remind you what you did" size="80"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <data format="tabular" name="out_file1" label="${title}_rgTDT.xls"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <data format="gff" name="gffout" label="${title}_rgTDT.gff"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 <data format="txt" name="logf" label="${title}_rgTDTlog.txt"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <param name='i' value='tinywga' ftype='pbed' >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <metadata name='base_name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <composite_data value='tinywga.bim' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <composite_data value='tinywga.bed' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <composite_data value='tinywga.fam' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <edit_attributes type='name' value='tinywga' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name='title' value='rgTDTtest1' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <output name='out_file1' file='rgTDTtest1_TDT.xls' ftype='tabular' compare="diff"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <output name='gffout' file='rgTDTtest1_TDT_topTable.gff' ftype='gff' compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <output name='logf' file='rgTDTtest1_TDT_log.txt' ftype='txt' lines_diff='79'/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 **Attribution**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 This tool relies on the work of many people. It uses Plink http://pngu.mgh.harvard.edu/~purcell/plink/ for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 analysis, and the R http://cran.r-project.org/ for graphics respectively.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 This implementation is a Galaxy tool wrapper around these third party applications.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 It was originally designed and written for family based data from the CAMP Illumina run of 2007 by
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 ross lazarus (ross.lazarus@gmail.com) and incorporated into the rgenetics toolkit.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 Rgenetics merely exposes them, wrapping Plink so you can use it in Galaxy.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 **Syntax**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 - **Genotype file** is the input family data chosen from available library compressed files
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 - **Format** determines how your data will be returned to your Galaxy workspace - the gg format is strongly recommended
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 **Summary**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 This tool will perform the standard transmission distortion analyses suitable for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 nuclear families and a simple binary "affected" phenotype
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 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
72 the Galaxy Get Data tool page.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 Outputs will include a GFF toptable with a link to view at UCSC if you want to see your
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 results as a fully fledged UCSC track.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 Finally, if you can't live without
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 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
79 one with a header. Fortunately excel is dumb enough to open these without much protest.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82 ----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 .. class:: infomark
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 This Galaxy tool relies on Plink (see Plinksrc_) to test TDT models.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 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
91 DOC_
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 Tool and Galaxy datatypes originally designed and written for the Rgenetics
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94 series of whole genome scale statistical genetics tools by ross lazarus (ross.lazarus@gmail.com)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96 Copyright Ross Lazarus March 2007
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 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
98
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 I'm no lawyer, but it looks like you got GPL if you use this software. Good luck.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 .. _Plinksrc: http://pngu.mgh.harvard.edu/~purcell/plink/
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 .. _LGPL: http://www.gnu.org/copyleft/lesser.html
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105 .. _DOC: http://pngu.mgh.harvard.edu/~purcell/plink/anal.shtml#tdt
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108 </tool>