diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2018-06-06 01:24:15 +0200 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2018-06-06 01:24:15 +0200 |
commit | 39b2c2c762b03922a2648b1b226d0f308600cc87 (patch) | |
tree | 4c3ae26ac0fe5360dea329c8815def2fc84dc269 /docs/reference/mkinfit.html | |
parent | 6ea7bc3614b9a303f7c38dd63b9f80b8d0ebd95e (diff) |
Static documentation rebuilt by pkgdown 1.1.0
Diffstat (limited to 'docs/reference/mkinfit.html')
-rw-r--r-- | docs/reference/mkinfit.html | 47 |
1 files changed, 32 insertions, 15 deletions
diff --git a/docs/reference/mkinfit.html b/docs/reference/mkinfit.html index 8ac8295f..d0b54098 100644 --- a/docs/reference/mkinfit.html +++ b/docs/reference/mkinfit.html @@ -21,12 +21,15 @@ <!-- clipboard.js --> <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script> +<!-- sticky kit --> +<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script> + <!-- pkgdown --> <link href="../pkgdown.css" rel="stylesheet"> -<script src="../jquery.sticky-kit.min.js"></script> <script src="../pkgdown.js"></script> - - + + + <meta property="og:title" content="Fit a kinetic model to data with one or more state variables — mkinfit" /> <meta property="og:description" content="This function uses the Flexible Modelling Environment package @@ -39,8 +42,11 @@ In each step of the optimsation, the kinetic model is solved using the function mkinpredict. The variance of the residuals for each observed variable can optionally be iteratively reweighted until convergence - using the argument reweight.method = "obs"." /> + using the argument reweight.method = "obs"." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -63,8 +69,12 @@ <span class="icon-bar"></span> <span class="icon-bar"></span> </button> - <a class="navbar-brand" href="../index.html">mkin</a> + <span class="navbar-brand"> + <a class="navbar-link" href="../index.html">mkin</a> + <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.9.47.1</span> + </span> </div> + <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav"> <li> @@ -105,6 +115,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -112,12 +123,15 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Fit a kinetic model to data with one or more state variables</h1> + + <div class="hidden name"><code>mkinfit.Rd</code></div> </div> + <div class="ref-description"> <p>This function uses the Flexible Modelling Environment package <code>FME</code> to create a function calculating the model cost, i.e. the @@ -131,6 +145,7 @@ observed variable can optionally be iteratively reweighted until convergence using the argument <code>reweight.method = "obs"</code>.</p> + </div> <pre class="usage"><span class='fu'>mkinfit</span>(<span class='no'>mkinmod</span>, <span class='no'>observed</span>, <span class='kw'>parms.ini</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, @@ -154,7 +169,7 @@ <span class='kw'>reweight.tol</span> <span class='kw'>=</span> <span class='fl'>1e-8</span>, <span class='kw'>reweight.max.iter</span> <span class='kw'>=</span> <span class='fl'>10</span>, <span class='kw'>trace_parms</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='no'>...</span>)</pre> - <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2> + <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2> <table class="ref-arguments"> <colgroup><col class="name" /><col class="desc" /></colgroup> <tr> @@ -384,10 +399,10 @@ <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2> - <p>Plotting methods <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code> and + <div class='dont-index'><p>Plotting methods <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code> and <code><a href='mkinparplot.html'>mkinparplot</a></code>.</p> <p>Fitting of several models to several datasets in a single call to - <code><a href='mmkin.html'>mmkin</a></code>.</p> + <code><a href='mmkin.html'>mmkin</a></code>.</p></div> <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2> @@ -413,16 +428,16 @@ <pre class="examples"><div class='input'><span class='co'># Use shorthand notation for parent only degradation</span> <span class='no'>fit</span> <span class='kw'><-</span> <span class='fu'>mkinfit</span>(<span class='st'>"FOMC"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) <span class='fu'>summary</span>(<span class='no'>fit</span>)</div><div class='output co'>#> mkin version used for fitting: 0.9.47.1 -#> R version used for fitting: 3.4.4 -#> Date of fit: Wed Mar 21 18:14:33 2018 -#> Date of summary: Wed Mar 21 18:14:33 2018 +#> R version used for fitting: 3.5.0 +#> Date of fit: Wed Jun 6 01:21:36 2018 +#> Date of summary: Wed Jun 6 01:21:36 2018 #> #> Equations: #> d_parent/dt = - (alpha/beta) * 1/((time/beta) + 1) * parent #> #> Model predictions using solution type analytical #> -#> Fitted with method Port using 64 model solutions performed in 0.14 s +#> Fitted with method Port using 64 model solutions performed in 0.143 s #> #> Weighting: none #> @@ -490,8 +505,8 @@ <span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='st'>"m1"</span>), <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>))</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'><span class='co'># Fit the model to the FOCUS example dataset D using defaults</span> <span class='fu'>print</span>(<span class='fu'>system.time</span>(<span class='no'>fit</span> <span class='kw'><-</span> <span class='fu'>mkinfit</span>(<span class='no'>SFO_SFO</span>, <span class='no'>FOCUS_2006_D</span>, - <span class='kw'>solution_type</span> <span class='kw'>=</span> <span class='st'>"eigen"</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)))</div><div class='output co'>#> user system elapsed -#> 0.834 0.000 0.835 </div><div class='input'><span class='fu'>coef</span>(<span class='no'>fit</span>)</div><div class='output co'>#> parent_0 log_k_parent_sink log_k_parent_m1 log_k_m1_sink + <span class='kw'>solution_type</span> <span class='kw'>=</span> <span class='st'>"eigen"</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)))</div><div class='output co'>#> User System verstrichen +#> 0.927 0.000 0.929 </div><div class='input'><span class='fu'>coef</span>(<span class='no'>fit</span>)</div><div class='output co'>#> parent_0 log_k_parent_sink log_k_parent_m1 log_k_m1_sink #> 99.59848 -3.03822 -2.98030 -5.24750 </div><div class='input'><span class='fu'><a href='endpoints.html'>endpoints</a></span>(<span class='no'>fit</span>)</div><div class='output co'>#> $ff #> parent_sink parent_m1 m1_sink #> 0.485524 0.514476 1.000000 @@ -597,6 +612,8 @@ </footer> </div> + + </body> </html> |