annotate tools/rgenetics/rgfakePed.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="rgfakePed1" name="Null genotypes" version="0.02">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>for testing</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">rgfakePed.py --title '$title'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 -o '$out_file1' -p '$out_file1.files_path' -c '$ncases' -n '$ntotal'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 -s '$nsnp' -w '$lowmaf' -v '$missingValue' -l '$outFormat'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 -d '$mafdist' -m '$missingRate' -M '$mendelRate' </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 <param name="title"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 type="text" value="Fake_test_geno_data"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 help="Name for outputs from this job"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 label="Descriptive short name"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <param name="ntotal"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 type="integer" value = "200"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 help="N total: total number of subjects"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 label="Create this total N subjects"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 <param name="ncases" type="integer"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 value="100"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 help = "N cases: Independent subjects with status set to 2. Set 0 for family data (NSubj/3 trios)"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 label="Total N Cases (0=generate family data - trios)"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <param name="nsnp"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 type="integer" value="1000"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 help="nsnp: total number of markers"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 label="Total N SNP"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 <param name="lowmaf" type="float"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 value="0.01"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 help = "Lower limit for MAF distribution"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 label="Lower MAF limit (default=1%)"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name="mafdist"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 type="select"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 help="Choose a MAF distribution"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 label="SNP Minor Allele Frequency distribution">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 <option value="U" selected="true">Uniform</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 <option value="T">Triangular (more low frequency SNPs)</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36 <param name="outFormat"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 type="select"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 help="Choose an output format"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 label="Output format file type - linkage ped or fbat ped">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 <option value="L" selected="true">Linkage format - separate .map file</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 <option value="F">fbat style - marker names in a header row</option>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 <param name="missingRate" type="float"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 value="0.05"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45 help = "Fraction of genotypes to be randomly set missing"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 label="Missing genotype call fraction"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47 <param name="mendelRate"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 type="float" value = "0.05"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 help="(family data) Fraction of apparently non-Mendelian transmission patterns"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 label="Mendel error transmission rate"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 <param name="missingValue" type="text" size="1"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 value='0'
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 help = "Missing allele value"
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 label="Missing value for an allele for the output ped file"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 <data format="lped" name="out_file1" label="${title}.lped"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 <param name='title' value='rgfakePedtest1' />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 <param name="ntotal" value="40" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 <param name="ncases" value="20" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 <param name="nsnp" value="10" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68 <param name="lowmaf" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69 <param name="mafdist" value="T" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 <param name="outFormat" value="L" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 <param name="missingRate" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
72 <param name="mendelRate" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
73 <param name="missingValue" value="0" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
74 <output name='out_file1' file='rgtestouts/rgfakePed/rgfakePedtest1.lped' ftype='lped' compare="diff" lines_diff='5'>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
75 <extra_files type="file" name='RgeneticsData.ped' value="rgtestouts/rgfakePed/rgfakePedtest1.ped" compare="diff" lines_diff='80'/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
76 <extra_files type="file" name='RgeneticsData.map' value="rgtestouts/rgfakePed/rgfakePedtest1.map" compare="diff" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
77 </output>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
78 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
79 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
80 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
81 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
82
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
83 This tool allows you to generate an arbitrary (sort of)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
84 synthetic genotype file (no attempt at LD - the markers are independent)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
85 with optional missingness, Mendel errors, minor allele frequency settings, family structure
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
86 These might be used for testing under
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
87 the null hypothesis of no association and are certainly useful for
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
88 scale testing.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
89
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
90 Note that although it runs reasonably fast given it's a script, generating a large data set takes
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
91 a while. An hour or so should get you a reasonable (3GB) sized simulated null data set..
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
92
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
93 A better simulator can easily be swapped in with this tool interface.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
94
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
95 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
96
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
97 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
98
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
99 This tool is very experimental
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
100
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
101 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
102
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
103 **Attribution and Licensing**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
104
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
105 Designed and written for the Rgenetics Galaxy tools
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
106 copyright Ross Lazarus 2007 (ross.lazarus@gmail.com)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
107 Licensed under the terms of the _LGPL
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
108
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
109 .. _LGPL: http://www.gnu.org/copyleft/lesser.html
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
110
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
111 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
112 </tool>