EVOLUTION-MANAGER
Edit File: tidy_optim.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: Tidy a(n) optim object masquerading as list</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 tidy_optim {broom}"><tr><td>tidy_optim {broom}</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Tidy a(n) optim object masquerading as list</h2> <h3>Description</h3> <p>Broom tidies a number of lists that are effectively S3 objects without a class attribute. For example, <code><a href="../../stats/html/optim.html">stats::optim()</a></code>, <a href="../../base/html/svd.html">svd()</a> and <code><a href="../../akima/html/interp.html">akima::interp()</a></code> produce consistent output, but because they do not have a class attribute, they cannot be handled by S3 dispatch. </p> <p>These functions look at the elements of a list and determine if there is an appropriate tidying method to apply to the list. Those tidiers are themselves are implemented as functions of the form <code style="white-space: pre;">tidy_<function></code> or <code style="white-space: pre;">glance_<function></code> and are not exported (but they are documented!). </p> <p>If no appropriate tidying method is found, throws an error. </p> <h3>Usage</h3> <pre> tidy_optim(x, ...) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>x</code></td> <td> <p>A list returned from <code><a href="../../stats/html/optim.html">stats::optim()</a></code>.</p> </td></tr> <tr valign="top"><td><code>...</code></td> <td> <p>Additional arguments. Not used. Needed to match generic signature only. <strong>Cautionary note:</strong> Misspelled arguments will be absorbed in <code>...</code>, where they will be ignored. If the misspelled argument has a default value, the default value will be used. For example, if you pass <code>conf.lvel = 0.9</code>, all computation will proceed using <code>conf.level = 0.95</code>. Additionally, if you pass <code>newdata = my_tibble</code> to an <code><a href="reexports.html">augment()</a></code> method that does not accept a <code>newdata</code> argument, it will use the default value for the <code>data</code> argument.</p> </td></tr> </table> <h3>Value</h3> <p>A <code><a href="../../tibble/html/tibble.html">tibble::tibble()</a></code> with columns: </p> <table summary="R valueblock"> <tr valign="top"><td><code>parameter</code></td> <td> <p>The parameter being modeled.</p> </td></tr> <tr valign="top"><td><code>std.error</code></td> <td> <p>The standard error of the regression term.</p> </td></tr> <tr valign="top"><td><code>value</code></td> <td> <p>The value/estimate of the component. Results from data reshaping.</p> </td></tr> </table> <p><code>std.error</code> is only provided as a column if the Hessian is calculated. </p> <h3>Note</h3> <p>This function assumes that the provided objective function is a negative log-likelihood function. Results will be invalid if an incorrect function is supplied. </p> <p>tidy(o) glance(o) </p> <h3>See Also</h3> <p><code><a href="reexports.html">tidy()</a></code>, <code><a href="../../stats/html/optim.html">stats::optim()</a></code> </p> <p>Other list tidiers: <code><a href="glance_optim.html">glance_optim</a>()</code>, <code><a href="list_tidiers.html">list_tidiers</a></code>, <code><a href="tidy_irlba.html">tidy_irlba</a>()</code>, <code><a href="tidy_svd.html">tidy_svd</a>()</code>, <code><a href="tidy_xyz.html">tidy_xyz</a>()</code> </p> <h3>Examples</h3> <pre> f <- function(x) (x[1] - 2)^2 + (x[2] - 3)^2 + (x[3] - 8)^2 o <- optim(c(1, 1, 1), f) </pre> <hr /><div style="text-align: center;">[Package <em>broom</em> version 0.7.0 <a href="00Index.html">Index</a>]</div> </body></html>