Debian Codegraph @

doc/pages/options.html

raw
1 <html>
2 <head>
3 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"/>
4 <meta http-equiv="Cache-Control" content="max-age=3600"/>
5 <meta name="description" content="description"/>
6 <meta name="keywords" content="keywords"/>
7 <meta name="author" content="author"/>
8 <link rel="stylesheet" type="text/css" href="../style/default.css" media="screen"/>
9 <title>FastQTL</title>
10 <script language="Javascript" src="../script/print_last_modif_date.js" ></script>
11 </head>
12
13 <body>
14 <div class="content">
15 <div class="item">
16 <div class="options">
17 <h1><font size="6">fastqtl [options]</font></h1>
18
19 <p>
20 Hereafter, the complete list of options for FastQTL in order to map cisQTL.
21 </p>
22
23 <table width=100%>
24 <tr>
25 <th width=30%>Basic options</th>
26 <th width=70%>Description</th>
27 </tr>
28 <tr>
29 <td>
30 <b>--help</b><br>
31 -H
32 </td>
33 <td>
34 Print help about options.
35 </td>
36 </tr>
37 <tr>
38 <td>
39 <b>--version</b><br>
40 -V
41 </td>
42 <td>
43 Print the FastQTL binary version.
44 </td>
45 </tr>
46 </table>
47
48 <br>
49 <br>
50 <table width=100%>
51 <tr>
52 <th width=30%>Input file options</th>
53 <th width=70%>Description</th>
54 </tr>
55
56 <tr>
57 <td>
58 <b>--vcf file.vcf</b><br>
59 -V file.vcf<br>
60 -V file.vcf.gz
61 </td>
62 <td>
63 Genotypes in VCF 4.1 format<br>
64 Field <b>DS</b> is used as default for dosages.<br>
65 If no DS field is present, FQTL derives dosages from the <b>GT</b> field.<br>
66 Brief description <a href="vcf.html" target='content'>here</a>.<br>
67 Detailed description <A href=http://vcftools.sourceforge.net/specs.html>here</A>.<br>
68 This file needs to be compressed with BGZIP and indexed with <A href=http://sourceforge.net/projects/samtools/files/tabix/>TABIX</A>.
69 </td>
70 </tr>
71
72 <tr>
73 <td>
74 <b>--bed file.bed</b><br>
75 -B file.bed<br>
76 -B file.bed.gz
77 </td>
78 <td>
79 Phenotypes in UCSC BED extended format.<br>
80 Brief description <a href="bed.html" target='content'>here</a>.<br>
81 Detailed description <A href=http://genome.ucsc.edu/FAQ/FAQformat.html#format1>here</A>.
82 This file needs to be compressed with BGZIP and indexed with <A href=http://sourceforge.net/projects/samtools/files/tabix/>TABIX</A>.
83 </td>
84 </tr>
85 </table>
86
87 <br>
88 <br>
89 <table width=100%>
90 <tr>
91 <th width=30%>Output file options</th>
92 <th width=70%>Description</th>
93 </tr>
94
95 <tr>
96 <td>
97 <b>--out file.results</b><br>
98 -O file.results.gz<br>
99 </td>
100 <td>
101 Output file.
102 </td>
103 </tr>
104
105 <tr>
106 <td>
107 <b>--log file.log</b><br>
108 -L file.log<br>
109 </td>
110 <td>
111 Log file. It is basically a copy of the screen output. If this option is not provided, the software will generate one automatically with a UUID based filename.
112 </td>
113 </tr>
114 </table>
115
116
117 <br>
118 <br>
119 <table width=100%>
120 <tr>
121 <th width=30%>Filtering options</th>
122 <th width=70%>Description</th>
123 </tr>
124
125 <tr>
126 <td>
127 <b>--exclude-samples file.exc</b><br>
128 <b>--exclude-sites file.exc</b><br>
129 <b>--exclude-phenotypes file.exc</b><br>
130 <b>--exclude-covariates file.exc</b>
131 </td>
132 <td>
133 To specify files containing all samples, variants, phenotypes or covariates to be excluded from the analysis.
134 </td>
135 </tr>
136
137 <tr>
138 <td>
139 <b>--include-samples file.exc</b><br>
140 <b>--include-sites file.exc</b><br>
141 <b>--include-phenotypes file.exc</b><br>
142 <b>--include-covariates file.exc</b>
143 </td>
144 <td>
145 To specify files containing all samples, variants, phenotypes or covariates to be included from the analysis.
146 </td>
147 </tr>
148 </table>
149
150 <br>
151 <br>
152 <table width=100%>
153 <tr>
154 <th width=30%>Method parameters</th>
155 <th width=70%>Description</th>
156 </tr>
157
158 <tr>
159 <td>
160 <b>--normal</b><br>
161 </td>
162 <td>
163 To perform quantile normalization on the phenotype quantifications to make them normally distributed.
164 Implemeted as the <i>rntransform</i> function of the GenABEL package. Can be found <A href=http://www.genabel.org/packages/GenABEL>here</A>.
165 </td>
166 </tr>
167 <tr>
168 <td>
169 <b>--window [float]</b><br>
170 </td>
171 <td>
172 Cis-window size. Default values is 1Mb (1e6).
173 It means that all variants within 1e6 bp of the phenotype location (e.g. TSS) is analyzed.
174 </td>
175 </tr>
176 <tr>
177 <td>
178 <b>--threshold [float]</b><br>
179 </td>
180 <td>
181 To filter out all phenotype-variant pairs with a p-value above the specified threshold in the output of a nominal pass.
182 </td>
183 </tr>
184 <tr>
185 <td>
186 <b>--permute [int]</b><br>
187 <b>--permute [int] [int]</b><br>
188 </td>
189 <td>
190 Perform permutations and report only best candidate QTL per MP. When one argument (=X) is given, a fixed number of permutations (=x) is performed.
191 When two arguments are given (=X1 and X2), the adaptive permutation scheme is used and between X1 and X2 permutations are performed depending on the significance of the tested MP.
192 </td>
193 </tr>
194 <tr>
195 <td>
196 <b>--seed</b><br>
197 </td>
198 <td>
199 Random number generator seed. Useful to replicate runs of the software.
200 </td>
201 </tr>
202 </table>
203
204 <br>
205 <br>
206 <table width=100%>
207 <tr>
208 <th width=30%>Parallelization</th>
209 <th width=70%>Description</th>
210 </tr>
211 <tr>
212 <td>
213 <b>--region chr:start-end</b><br>
214 -R 12:1000000-2000000
215 </td>
216 <td>
217 Define a chunk of molecular phenotypes to be processed.
218 Genotype data is automatically extracted given the phenotype region and the cis-window size.
219 </td>
220 </tr>
221 <tr>
222 <td>
223 <b>--chunk [int] [int]</b>
224 </td>
225 <td>
226 Specify which chunk of data needs to be processed. Needs two arguments (=X1, X2). Tells to FastQTL to process chunk X1 out of X2 chunks.
227 </td>
228 </tr>
229
230 <tr>
231 <td>
232 <b>--commands [int] file.commands</b>
233 </td>
234 <td>
235 Split the whole analysis in X jobs (first argument) and write the resulting X commands in <i>file.commands</i>.
236 </td>
237 </tr>
238
239 </table>
240
241 </div>
242 </div>
243
244 <div class="log"><script type="text/javascript"> print_last_modif_date("$Date: 2015-01-22 00:08:17 +0100 (Thu, 22 Jan 2015) $"); </script></div>
245 </div>
246 </body>
247 </html>