EVOLUTION-MANAGER
Edit File: ripple.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><title>R: Compare marker orders</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body> <table width="100%" summary="page for ripple {qtl}"><tr><td>ripple {qtl}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Compare marker orders</h2> <h3>Description</h3> <p>Investigate different marker orders for a given chromosome, comparing all possible permutations of a sliding window of markers. </p> <h3>Usage</h3> <pre> ripple(cross, chr, window=4, method=c("countxo","likelihood"), error.prob=0.0001, map.function=c("haldane","kosambi","c-f","morgan"), maxit=4000, tol=1e-6, sex.sp=TRUE, verbose=TRUE, n.cluster=1) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>cross</code></td> <td> <p>An object of class <code>cross</code>. See <code><a href="read.cross.html">read.cross</a></code> for details.</p> </td></tr> <tr valign="top"><td><code>chr</code></td> <td> <p>The chromosome to investigate. Only one chromosome is allowed. (This should be a character string referring to the chromosomes by name.)</p> </td></tr> <tr valign="top"><td><code>window</code></td> <td> <p>Number of markers to include in the sliding window of permuted markers. Larger numbers result in the comparison of a greater number of marker orders, but will require a considerable increase in computation time.</p> </td></tr> <tr valign="top"><td><code>method</code></td> <td> <p>Indicates whether to compare orders by counting the number of obligate crossovers, or by a likelihood analysis.</p> </td></tr> <tr valign="top"><td><code>error.prob</code></td> <td> <p>Assumed genotyping error rate used in the calculation of the penetrance Pr(observed genotype | true genotype).</p> </td></tr> <tr valign="top"><td><code>map.function</code></td> <td> <p>Indicates whether to use the Haldane, Kosambi, Carter-Falconer, or Morgan map function when converting genetic distances into recombination fractions.</p> </td></tr> <tr valign="top"><td><code>maxit</code></td> <td> <p>Maximum number of EM iterations to perform.</p> </td></tr> <tr valign="top"><td><code>tol</code></td> <td> <p>Tolerance for determining convergence.</p> </td></tr> <tr valign="top"><td><code>sex.sp</code></td> <td> <p>Indicates whether to estimate sex-specific maps; this is used only for the 4-way cross.</p> </td></tr> <tr valign="top"><td><code>verbose</code></td> <td> <p>If TRUE, information about the number of orders (and, if <code>method="likelihood"</code>, about progress) are printed.</p> </td></tr> <tr valign="top"><td><code>n.cluster</code></td> <td> <p>If the package <code>snow</code> is available and <code>n.perm</code> > 0, permutations are run in parallel using this number of nodes. This is really only useful with <code>method="likelihood"</code>.</p> </td></tr> </table> <h3>Details</h3> <p>For <code>method="likelihood"</code>, calculations are done by first constructing a matrix of marker orders and then making repeated calls to the R function <code><a href="est.map.html">est.map</a></code>. Of course, it would be faster to do everything within C, but this was a lot easier to code. </p> <p>For <code>method="countxo"</code>, calculations are done within C. </p> <h3>Value</h3> <p>A matrix, given class <code>"ripple"</code>; the first set of columns are marker indices describing the order. In the case of <code>method="countxo"</code>, the last column is the number of obligate crossovers for each particular order. In the case of <code>method="likelihood"</code>, the last two columns are LOD scores (log base 10 likelihood ratios) comparing each order to the initial order and the estimated chromosome length for the given order. Positive LOD scores indicate that the alternate order has more support than the original. </p> <h3>Author(s)</h3> <p>Karl W Broman, <a href="mailto:broman@wisc.edu">broman@wisc.edu</a> </p> <h3>See Also</h3> <p><code><a href="summary.ripple.html">summary.ripple</a></code>, <code><a href="switch.order.html">switch.order</a></code>, <code><a href="est.map.html">est.map</a></code>, <code><a href="est.rf.html">est.rf</a></code> </p> <h3>Examples</h3> <pre> data(badorder) rip1 <- ripple(badorder, chr=1, window=3) summary(rip1) ## Not run: rip2 <- ripple(badorder, chr=1, window=2, method="likelihood") summary(rip2) ## End(Not run) badorder <- switch.order(badorder, 1, rip1[2,]) </pre> <hr /><div style="text-align: center;">[Package <em>qtl</em> version 1.66 <a href="00Index.html">Index</a>]</div> </body></html>