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 | |
| parent | 6ea7bc3614b9a303f7c38dd63b9f80b8d0ebd95e (diff) | |
Static documentation rebuilt by pkgdown 1.1.0
Diffstat (limited to 'docs/reference')
57 files changed, 1296 insertions, 607 deletions
diff --git a/docs/reference/DFOP.solution-1.png b/docs/reference/DFOP.solution-1.png Binary files differindex e9268f94..0fbc1da1 100644 --- a/docs/reference/DFOP.solution-1.png +++ b/docs/reference/DFOP.solution-1.png diff --git a/docs/reference/DFOP.solution.html b/docs/reference/DFOP.solution.html index b1b3cf50..cd8f29e9 100644 --- a/docs/reference/DFOP.solution.html +++ b/docs/reference/DFOP.solution.html @@ -21,17 +21,23 @@ <!-- 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="Double First-Order in Parallel kinetics — DFOP.solution" /> <meta property="og:description" content="Function describing decline from a defined starting value using the sum of two exponential decline functions." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,20 +114,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Double First-Order in Parallel kinetics</h1> + + <div class="hidden name"><code>DFOP.solution.Rd</code></div> </div> + <div class="ref-description"> <p>Function describing decline from a defined starting value using the sum of two exponential decline functions.</p> + </div> <pre class="usage"><span class='fu'>DFOP.solution</span>(<span class='no'>t</span>, <span class='no'>parent.0</span>, <span class='no'>k1</span>, <span class='no'>k2</span>, <span class='no'>g</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> @@ -156,7 +171,7 @@ <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'> <span class='fu'>plot</span>(<span class='kw'>function</span>(<span class='no'>x</span>) <span class='fu'>DFOP.solution</span>(<span class='no'>x</span>, <span class='fl'>100</span>, <span class='fl'>5</span>, <span class='fl'>0.5</span>, <span class='fl'>0.3</span>), <span class='fl'>0</span>, <span class='fl'>4</span>, <span class='kw'>ylim</span><span class='kw'>=</span><span class='fu'>c</span>(<span class='fl'>0</span>,<span class='fl'>100</span>))</div><div class='img'><img src='DFOP.solution-1.png' alt='' width='700' height='432.632880098887' /></div></pre> + <pre class="examples"><div class='input'> <span class='fu'>plot</span>(<span class='kw'>function</span>(<span class='no'>x</span>) <span class='fu'>DFOP.solution</span>(<span class='no'>x</span>, <span class='fl'>100</span>, <span class='fl'>5</span>, <span class='fl'>0.5</span>, <span class='fl'>0.3</span>), <span class='fl'>0</span>, <span class='fl'>4</span>, <span class='kw'>ylim</span><span class='kw'>=</span><span class='fu'>c</span>(<span class='fl'>0</span>,<span class='fl'>100</span>))</div><div class='img'><img src='DFOP.solution-1.png' alt='' width='700' height='433' /></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -185,6 +200,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/Extract.mmkin.html b/docs/reference/Extract.mmkin.html index 2a3b1c78..deb418c2 100644 --- a/docs/reference/Extract.mmkin.html +++ b/docs/reference/Extract.mmkin.html @@ -21,16 +21,22 @@ <!-- 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="Subsetting method for mmkin objects — [.mmkin" /> <meta property="og:description" content="Subsetting method for mmkin objects." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,20 +113,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Subsetting method for mmkin objects</h1> + + <div class="hidden name"><code>Extract.mmkin.Rd</code></div> </div> + <div class="ref-description"> <p>Subsetting method for mmkin objects.</p> + </div> <pre class="usage"># S3 method for mmkin [(x, i, j, ..., drop = FALSE)</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> @@ -262,8 +277,8 @@ #> [1] 29 #> #> $time -#> user system elapsed -#> 0.242 0.000 0.244 +#> User System verstrichen +#> 0.179 0.000 0.184 #> #> $mkinmod #> <mkinmod> model generated with @@ -452,8 +467,8 @@ #> } #> return(mC) #> } -#> <bytecode: 0x5555578ff9d0> -#> <environment: 0x555559a0da40> +#> <bytecode: 0x55555b9b9d58> +#> <environment: 0x55555be59518> #> #> $cost_notrans #> function (P) @@ -475,8 +490,8 @@ #> scaleVar = scaleVar) #> return(mC) #> } -#> <bytecode: 0x555559b90d60> -#> <environment: 0x555559a0da40> +#> <bytecode: 0x55555c2673f8> +#> <environment: 0x55555be59518> #> #> $hessian_notrans #> parent_0 k_parent_sink @@ -495,7 +510,7 @@ #> #> $fixed #> [1] value type -#> <0 rows> (or 0-length row.names) +#> <0 Zeilen> (oder row.names mit Länge 0) #> #> $data #> time variable observed predicted residual @@ -543,13 +558,13 @@ #> 99.17407 #> #> $date -#> [1] "Wed Mar 21 18:14:20 2018" +#> [1] "Wed Jun 6 01:21:24 2018" #> #> $version #> [1] "0.9.47.1" #> #> $Rversion -#> [1] "3.4.4" +#> [1] "3.5.0" #> #> attr(,"class") #> [1] "mkinfit" "modFit" @@ -584,6 +599,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/FOCUS_2006_DFOP_ref_A_to_B.html b/docs/reference/FOCUS_2006_DFOP_ref_A_to_B.html index f392bf64..78caf48d 100644 --- a/docs/reference/FOCUS_2006_DFOP_ref_A_to_B.html +++ b/docs/reference/FOCUS_2006_DFOP_ref_A_to_B.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="Results of fitting the DFOP model to Datasets A to B of FOCUS (2006) — FOCUS_2006_DFOP_ref_A_to_B" /> <meta property="og:description" content="A table with the fitted parameters and the resulting DT50 and DT90 values @@ -35,6 +38,9 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,12 @@ in this fit." /> <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> @@ -99,6 +109,7 @@ in this fit." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ in this fit." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Results of fitting the DFOP model to Datasets A to B of FOCUS (2006)</h1> + + <div class="hidden name"><code>FOCUS_2006_DFOP_ref_A_to_B.Rd</code></div> </div> + <div class="ref-description"> <p>A table with the fitted parameters and the resulting DT50 and DT90 values generated with different software packages. Taken directly from FOCUS (2006). @@ -119,6 +133,7 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit.</p> + </div> <pre class="usage"><span class='no'>FOCUS_2006_DFOP_ref_A_to_B</span></pre> @@ -173,6 +188,8 @@ in this fit.</p> </footer> </div> + + </body> </html> diff --git a/docs/reference/FOCUS_2006_FOMC_ref_A_to_F.html b/docs/reference/FOCUS_2006_FOMC_ref_A_to_F.html index 6e4c8d64..c854c11c 100644 --- a/docs/reference/FOCUS_2006_FOMC_ref_A_to_F.html +++ b/docs/reference/FOCUS_2006_FOMC_ref_A_to_F.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="Results of fitting the FOMC model to Datasets A to F of FOCUS (2006) — FOCUS_2006_FOMC_ref_A_to_F" /> <meta property="og:description" content="A table with the fitted parameters and the resulting DT50 and DT90 values @@ -35,6 +38,9 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,12 @@ in this fit." /> <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> @@ -99,6 +109,7 @@ in this fit." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ in this fit." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Results of fitting the FOMC model to Datasets A to F of FOCUS (2006)</h1> + + <div class="hidden name"><code>FOCUS_2006_FOMC_ref_A_to_F.Rd</code></div> </div> + <div class="ref-description"> <p>A table with the fitted parameters and the resulting DT50 and DT90 values generated with different software packages. Taken directly from FOCUS (2006). @@ -119,6 +133,7 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit.</p> + </div> <pre class="usage"><span class='no'>FOCUS_2006_FOMC_ref_A_to_F</span></pre> @@ -172,6 +187,8 @@ in this fit.</p> </footer> </div> + + </body> </html> diff --git a/docs/reference/FOCUS_2006_HS_ref_A_to_F.html b/docs/reference/FOCUS_2006_HS_ref_A_to_F.html index ed38ccae..89ee9ae9 100644 --- a/docs/reference/FOCUS_2006_HS_ref_A_to_F.html +++ b/docs/reference/FOCUS_2006_HS_ref_A_to_F.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="Results of fitting the HS model to Datasets A to F of FOCUS (2006) — FOCUS_2006_HS_ref_A_to_F" /> <meta property="og:description" content="A table with the fitted parameters and the resulting DT50 and DT90 values @@ -35,6 +38,9 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,12 @@ in this fit." /> <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> @@ -99,6 +109,7 @@ in this fit." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ in this fit." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Results of fitting the HS model to Datasets A to F of FOCUS (2006)</h1> + + <div class="hidden name"><code>FOCUS_2006_HS_ref_A_to_F.Rd</code></div> </div> + <div class="ref-description"> <p>A table with the fitted parameters and the resulting DT50 and DT90 values generated with different software packages. Taken directly from FOCUS (2006). @@ -119,6 +133,7 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit.</p> + </div> <pre class="usage"><span class='no'>FOCUS_2006_HS_ref_A_to_F</span></pre> @@ -173,6 +188,8 @@ in this fit.</p> </footer> </div> + + </body> </html> diff --git a/docs/reference/FOCUS_2006_SFO_ref_A_to_F.html b/docs/reference/FOCUS_2006_SFO_ref_A_to_F.html index 107f3e5f..182c7003 100644 --- a/docs/reference/FOCUS_2006_SFO_ref_A_to_F.html +++ b/docs/reference/FOCUS_2006_SFO_ref_A_to_F.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="Results of fitting the SFO model to Datasets A to F of FOCUS (2006) — FOCUS_2006_SFO_ref_A_to_F" /> <meta property="og:description" content="A table with the fitted parameters and the resulting DT50 and DT90 values @@ -35,6 +38,9 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,12 @@ in this fit." /> <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> @@ -99,6 +109,7 @@ in this fit." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ in this fit." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Results of fitting the SFO model to Datasets A to F of FOCUS (2006)</h1> + + <div class="hidden name"><code>FOCUS_2006_SFO_ref_A_to_F.Rd</code></div> </div> + <div class="ref-description"> <p>A table with the fitted parameters and the resulting DT50 and DT90 values generated with different software packages. Taken directly from FOCUS (2006). @@ -119,6 +133,7 @@ The results from fitting the data with the Topfit software was removed, as the initial concentration of the parent compound was fixed to a value of 100 in this fit.</p> + </div> <pre class="usage"><span class='no'>FOCUS_2006_SFO_ref_A_to_F</span></pre> @@ -171,6 +186,8 @@ in this fit.</p> </footer> </div> + + </body> </html> diff --git a/docs/reference/FOCUS_2006_datasets.html b/docs/reference/FOCUS_2006_datasets.html index cc310ee3..aa84e14b 100644 --- a/docs/reference/FOCUS_2006_datasets.html +++ b/docs/reference/FOCUS_2006_datasets.html @@ -21,16 +21,22 @@ <!-- 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="Datasets A to F from the FOCUS Kinetics report from 2006 — FOCUS_2006_datasets" /> <meta property="og:description" content="Data taken from FOCUS (2006), p. 258." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,15 +113,19 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Datasets A to F from the FOCUS Kinetics report from 2006</h1> + + <div class="hidden name"><code>FOCUS_2006_datasets.Rd</code></div> </div> + <div class="ref-description"> <p>Data taken from FOCUS (2006), p. 258.</p> + </div> <pre class="usage"><span class='no'>FOCUS_2006_datasets</span></pre> @@ -169,6 +184,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/FOMC.solution-1.png b/docs/reference/FOMC.solution-1.png Binary files differindex f10cff4e..127f3085 100644 --- a/docs/reference/FOMC.solution-1.png +++ b/docs/reference/FOMC.solution-1.png diff --git a/docs/reference/FOMC.solution.html b/docs/reference/FOMC.solution.html index 397dc82d..4b8f1c92 100644 --- a/docs/reference/FOMC.solution.html +++ b/docs/reference/FOMC.solution.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="First-Order Multi-Compartment kinetics — FOMC.solution" /> <meta property="og:description" content="Function describing exponential decline from a defined starting value, with @@ -35,6 +38,9 @@ The form given here differs slightly from the original reference by Gustafson and Holden (1990). The parameter beta corresponds to 1/beta in the original equation." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,12 @@ The form given here differs slightly from the original reference by Gustafson <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> @@ -99,6 +109,7 @@ The form given here differs slightly from the original reference by Gustafson <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ The form given here differs slightly from the original reference by Gustafson </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>First-Order Multi-Compartment kinetics</h1> + + <div class="hidden name"><code>FOMC.solution.Rd</code></div> </div> + <div class="ref-description"> <p>Function describing exponential decline from a defined starting value, with a decreasing rate constant.</p> @@ -119,10 +133,11 @@ The form given here differs slightly from the original reference by Gustafson and Holden (1990). The parameter <code>beta</code> corresponds to 1/beta in the original equation.</p> + </div> <pre class="usage"><span class='fu'>FOMC.solution</span>(<span class='no'>t</span>, <span class='no'>parent.0</span>, <span class='no'>alpha</span>, <span class='no'>beta</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> @@ -168,7 +183,7 @@ The form given here differs slightly from the original reference by Gustafson <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'> <span class='fu'>plot</span>(<span class='kw'>function</span>(<span class='no'>x</span>) <span class='fu'>FOMC.solution</span>(<span class='no'>x</span>, <span class='fl'>100</span>, <span class='fl'>10</span>, <span class='fl'>2</span>), <span class='fl'>0</span>, <span class='fl'>2</span>, <span class='kw'>ylim</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='fl'>0</span>, <span class='fl'>100</span>))</div><div class='img'><img src='FOMC.solution-1.png' alt='' width='700' height='432.632880098887' /></div></pre> + <pre class="examples"><div class='input'> <span class='fu'>plot</span>(<span class='kw'>function</span>(<span class='no'>x</span>) <span class='fu'>FOMC.solution</span>(<span class='no'>x</span>, <span class='fl'>100</span>, <span class='fl'>10</span>, <span class='fl'>2</span>), <span class='fl'>0</span>, <span class='fl'>2</span>, <span class='kw'>ylim</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='fl'>0</span>, <span class='fl'>100</span>))</div><div class='img'><img src='FOMC.solution-1.png' alt='' width='700' height='433' /></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -199,6 +214,8 @@ The form given here differs slightly from the original reference by Gustafson </footer> </div> + + </body> </html> diff --git a/docs/reference/HS.solution-1.png b/docs/reference/HS.solution-1.png Binary files differindex 5e04d343..4dc42c31 100644 --- a/docs/reference/HS.solution-1.png +++ b/docs/reference/HS.solution-1.png diff --git a/docs/reference/HS.solution.html b/docs/reference/HS.solution.html index f633aa67..d06a839e 100644 --- a/docs/reference/HS.solution.html +++ b/docs/reference/HS.solution.html @@ -21,17 +21,23 @@ <!-- 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="Hockey-Stick kinetics — HS.solution" /> <meta property="og:description" content="Function describing two exponential decline functions with a break point between them." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,20 +114,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Hockey-Stick kinetics</h1> + + <div class="hidden name"><code>HS.solution.Rd</code></div> </div> + <div class="ref-description"> <p>Function describing two exponential decline functions with a break point between them.</p> + </div> <pre class="usage"><span class='fu'>HS.solution</span>(<span class='no'>t</span>, <span class='no'>parent.0</span>, <span class='no'>k1</span>, <span class='no'>k2</span>, <span class='no'>tb</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> @@ -157,7 +172,7 @@ <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'> <span class='fu'>plot</span>(<span class='kw'>function</span>(<span class='no'>x</span>) <span class='fu'>HS.solution</span>(<span class='no'>x</span>, <span class='fl'>100</span>, <span class='fl'>2</span>, <span class='fl'>0.3</span>, <span class='fl'>0.5</span>), <span class='fl'>0</span>, <span class='fl'>2</span>, <span class='kw'>ylim</span><span class='kw'>=</span><span class='fu'>c</span>(<span class='fl'>0</span>,<span class='fl'>100</span>))</div><div class='img'><img src='HS.solution-1.png' alt='' width='700' height='432.632880098887' /></div></pre> + <pre class="examples"><div class='input'> <span class='fu'>plot</span>(<span class='kw'>function</span>(<span class='no'>x</span>) <span class='fu'>HS.solution</span>(<span class='no'>x</span>, <span class='fl'>100</span>, <span class='fl'>2</span>, <span class='fl'>0.3</span>, <span class='fl'>0.5</span>), <span class='fl'>0</span>, <span class='fl'>2</span>, <span class='kw'>ylim</span><span class='kw'>=</span><span class='fu'>c</span>(<span class='fl'>0</span>,<span class='fl'>100</span>))</div><div class='img'><img src='HS.solution-1.png' alt='' width='700' height='433' /></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -186,6 +201,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/IORE.solution-1.png b/docs/reference/IORE.solution-1.png Binary files differindex e421d562..d8b6e8e3 100644 --- a/docs/reference/IORE.solution-1.png +++ b/docs/reference/IORE.solution-1.png diff --git a/docs/reference/IORE.solution.html b/docs/reference/IORE.solution.html index 687dee5a..c037a8d2 100644 --- a/docs/reference/IORE.solution.html +++ b/docs/reference/IORE.solution.html @@ -21,17 +21,23 @@ <!-- 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="Indeterminate order rate equation kinetics — IORE.solution" /> <meta property="og:description" content="Function describing exponential decline from a defined starting value, with a concentration dependent rate constant." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,20 +114,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Indeterminate order rate equation kinetics</h1> + + <div class="hidden name"><code>IORE.solution.Rd</code></div> </div> + <div class="ref-description"> <p>Function describing exponential decline from a defined starting value, with a concentration dependent rate constant.</p> + </div> <pre class="usage"><span class='fu'>IORE.solution</span>(<span class='no'>t</span>, <span class='no'>parent.0</span>, <span class='no'>k__iore</span>, <span class='no'>N</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> @@ -157,7 +172,7 @@ <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> <pre class="examples"><div class='input'> <span class='fu'>plot</span>(<span class='kw'>function</span>(<span class='no'>x</span>) <span class='fu'>IORE.solution</span>(<span class='no'>x</span>, <span class='fl'>100</span>, <span class='fl'>0.2</span>, <span class='fl'>1.3</span>), <span class='fl'>0</span>, <span class='fl'>2</span>, - <span class='kw'>ylim</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='fl'>0</span>, <span class='fl'>100</span>))</div><div class='img'><img src='IORE.solution-1.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> <span class='no'>fit.fomc</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></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='kw'>ylim</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='fl'>0</span>, <span class='fl'>100</span>))</div><div class='img'><img src='IORE.solution-1.png' alt='' width='700' height='433' /></div><div class='input'> <span class='no'>fit.fomc</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></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='no'>fit.iore</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='st'>"IORE"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) <span class='no'>fit.iore.deS</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='st'>"IORE"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>solution_type</span> <span class='kw'>=</span> <span class='st'>"deSolve"</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) @@ -200,6 +215,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/SFO.solution.html b/docs/reference/SFO.solution.html index 1156c16f..32ef9f29 100644 --- a/docs/reference/SFO.solution.html +++ b/docs/reference/SFO.solution.html @@ -21,16 +21,22 @@ <!-- 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="Single First-Order kinetics — SFO.solution" /> <meta property="og:description" content="Function describing exponential decline from a defined starting value." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,19 +113,23 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Single First-Order kinetics</h1> + + <div class="hidden name"><code>SFO.solution.Rd</code></div> </div> + <div class="ref-description"> <p>Function describing exponential decline from a defined starting value.</p> + </div> <pre class="usage"><span class='fu'>SFO.solution</span>(<span class='no'>t</span>, <span class='no'>parent.0</span>, <span class='no'>k</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> @@ -176,6 +191,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/SFORB.solution.html b/docs/reference/SFORB.solution.html index 6901c435..aee32558 100644 --- a/docs/reference/SFORB.solution.html +++ b/docs/reference/SFORB.solution.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="Single First-Order Reversible Binding kinetics — SFORB.solution" /> <meta property="og:description" content="Function describing the solution of the differential equations describing @@ -35,6 +38,9 @@ fraction. The initial condition is a defined amount in the free fraction and no substance in the bound fraction." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,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> @@ -99,6 +109,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Single First-Order Reversible Binding kinetics</h1> + + <div class="hidden name"><code>SFORB.solution.Rd</code></div> </div> + <div class="ref-description"> <p>Function describing the solution of the differential equations describing the kinetic model with first-order terms for a two-way transfer from a free @@ -119,10 +133,11 @@ fraction. The initial condition is a defined amount in the free fraction and no substance in the bound fraction.</p> + </div> <pre class="usage"><span class='fu'>SFORB.solution</span>(<span class='no'>t</span>, <span class='no'>parent.0</span>, <span class='no'>k_12</span>, <span class='no'>k_21</span>, <span class='no'>k_1output</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> @@ -193,6 +208,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/add_err-1.png b/docs/reference/add_err-1.png Binary files differindex fecfc52d..d099898c 100644 --- a/docs/reference/add_err-1.png +++ b/docs/reference/add_err-1.png diff --git a/docs/reference/add_err-2.png b/docs/reference/add_err-2.png Binary files differindex 907001ed..f6de95a0 100644 --- a/docs/reference/add_err-2.png +++ b/docs/reference/add_err-2.png diff --git a/docs/reference/add_err-3.png b/docs/reference/add_err-3.png Binary files differindex 3786d934..13f54e65 100644 --- a/docs/reference/add_err-3.png +++ b/docs/reference/add_err-3.png diff --git a/docs/reference/add_err.html b/docs/reference/add_err.html index 6d830113..063234b3 100644 --- a/docs/reference/add_err.html +++ b/docs/reference/add_err.html @@ -21,18 +21,24 @@ <!-- 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="Add normally distributed errors to simulated kinetic degradation data — add_err" /> <meta property="og:description" content="Normally distributed errors are added to data predicted for a specific degradation model using mkinpredict. The variance of the error may depend on the predicted value and is specified as a standard deviation." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -55,8 +61,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> @@ -97,6 +107,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -104,23 +115,27 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Add normally distributed errors to simulated kinetic degradation data</h1> + + <div class="hidden name"><code>add_err.Rd</code></div> </div> + <div class="ref-description"> <p>Normally distributed errors are added to data predicted for a specific degradation model using <code><a href='mkinpredict.html'>mkinpredict</a></code>. The variance of the error may depend on the predicted value and is specified as a standard deviation.</p> + </div> <pre class="usage"><span class='fu'>add_err</span>(<span class='no'>prediction</span>, <span class='no'>sdfunc</span>, <span class='kw'>secondary</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"M1"</span>, <span class='st'>"M2"</span>), <span class='kw'>n</span> <span class='kw'>=</span> <span class='fl'>1000</span>, <span class='kw'>LOD</span> <span class='kw'>=</span> <span class='fl'>0.1</span>, <span class='kw'>reps</span> <span class='kw'>=</span> <span class='fl'>2</span>, <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>seed</span> <span class='kw'>=</span> <span class='fl'>NA</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> @@ -204,14 +219,14 @@ <span class='no'>d_SFO_SFO_err</span>, <span class='kw'>cores</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>method.modFit</span> <span class='kw'>=</span> <span class='st'>"Marq"</span>) -<span class='fu'>plot</span>(<span class='no'>f_SFO_SFO</span>)</div><div class='img'><img src='add_err-1.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> +<span class='fu'>plot</span>(<span class='no'>f_SFO_SFO</span>)</div><div class='img'><img src='add_err-1.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># We would like to inspect the fit for dataset 3 more closely</span> <span class='co'># Using double brackets makes the returned object an mkinfit object</span> <span class='co'># instead of a list of mkinfit objects, so plot.mkinfit is used</span> -<span class='fu'>plot</span>(<span class='no'>f_SFO_SFO</span><span class='kw'>[[</span><span class='fl'>3</span>]], <span class='kw'>show_residuals</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='img'><img src='add_err-2.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> +<span class='fu'>plot</span>(<span class='no'>f_SFO_SFO</span><span class='kw'>[[</span><span class='fl'>3</span>]], <span class='kw'>show_residuals</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='img'><img src='add_err-2.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># If we use single brackets, we should give two indices (model and dataset),</span> <span class='co'># and plot.mmkin is used</span> -<span class='fu'>plot</span>(<span class='no'>f_SFO_SFO</span>[<span class='fl'>1</span>, <span class='fl'>3</span>])</div><div class='img'><img src='add_err-3.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> +<span class='fu'>plot</span>(<span class='no'>f_SFO_SFO</span>[<span class='fl'>1</span>, <span class='fl'>3</span>])</div><div class='img'><img src='add_err-3.png' alt='' width='700' height='433' /></div><div class='input'> </div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> @@ -245,6 +260,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/endpoints.html b/docs/reference/endpoints.html index 0f5ba0a4..b10998fb 100644 --- a/docs/reference/endpoints.html +++ b/docs/reference/endpoints.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="Function to calculate endpoints for further use from kinetic models fitted with mkinfit — endpoints" /> <meta property="og:description" content="This function calculates DT50 and DT90 values as well as formation fractions from kinetic models @@ -34,6 +37,9 @@ fitted with mkinfit. If the SFORB model was specified for one of the parents or the Eigenvalues are returned. These are equivalent to the rate constantes of the DFOP model, but with the advantage that the SFORB model can also be used for metabolites." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -56,8 +62,12 @@ with the advantage that the SFORB model can also be used for metabolites." /> <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> @@ -98,6 +108,7 @@ with the advantage that the SFORB model can also be used for metabolites." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -105,22 +116,26 @@ with the advantage that the SFORB model can also be used for metabolites." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Function to calculate endpoints for further use from kinetic models fitted with mkinfit</h1> + + <div class="hidden name"><code>endpoints.Rd</code></div> </div> + <div class="ref-description"> <p>This function calculates DT50 and DT90 values as well as formation fractions from kinetic models fitted with mkinfit. If the SFORB model was specified for one of the parents or metabolites, the Eigenvalues are returned. These are equivalent to the rate constantes of the DFOP model, but with the advantage that the SFORB model can also be used for metabolites.</p> + </div> <pre class="usage"><span class='fu'>endpoints</span>(<span class='no'>fit</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> @@ -182,6 +197,8 @@ with the advantage that the SFORB model can also be used for metabolites.</p> </footer> </div> + + </body> </html> diff --git a/docs/reference/geometric_mean.html b/docs/reference/geometric_mean.html index 9d91b5a8..90b6fd9d 100644 --- a/docs/reference/geometric_mean.html +++ b/docs/reference/geometric_mean.html @@ -21,16 +21,22 @@ <!-- 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="Calculate the geometric mean — geometric_mean" /> <meta property="og:description" content="Function calculating the geometric mean of numeric vectors" /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,19 +113,23 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Calculate the geometric mean</h1> + + <div class="hidden name"><code>geometric_mean.Rd</code></div> </div> + <div class="ref-description"> <p>Function calculating the geometric mean of numeric vectors</p> + </div> <pre class="usage"><span class='fu'>geometric_mean</span>(<span class='no'>x</span>, <span class='kw'>na.rm</span> <span class='kw'>=</span> <span class='fl'>FALSE</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> @@ -160,6 +175,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/ilr.html b/docs/reference/ilr.html index 33d749ce..8f337595 100644 --- a/docs/reference/ilr.html +++ b/docs/reference/ilr.html @@ -21,16 +21,22 @@ <!-- 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="Function to perform isometric log-ratio transformation — ilr" /> <meta property="og:description" content="This implementation is a special case of the class of isometric log-ratio transformations." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,20 +113,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Function to perform isometric log-ratio transformation</h1> + + <div class="hidden name"><code>ilr.Rd</code></div> </div> + <div class="ref-description"> <p>This implementation is a special case of the class of isometric log-ratio transformations.</p> + </div> <pre class="usage"><span class='fu'>ilr</span>(<span class='no'>x</span>) <span class='fu'>invilr</span>(<span class='no'>x</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> @@ -136,7 +151,7 @@ <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2> - <p>Another implementation can be found in R package <code>robCompositions</code>.</p> + <div class='dont-index'><p>Another implementation can be found in R package <code>robCompositions</code>.</p></div> <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> @@ -184,6 +199,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/index.html b/docs/reference/index.html index 6c05941d..5785b5aa 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -21,13 +21,19 @@ <!-- 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="Function reference" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -50,8 +56,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> @@ -92,6 +102,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -99,330 +110,326 @@ </header> - <div class="row"> - <div class="col-md-9"> +<div class="row"> + <div class="contents col-md-9"> <div class="page-header"> - <h1> - Reference - <small>version 0.9.47.1</small> - </h1> + <h1>Reference</h1> </div> - <div class="contents"> - <table class="ref-index"> + <table class="ref-index"> - <colgroup> - <col class="alias" /> - <col class="title" /> - </colgroup> + <colgroup> + + <col class="alias" /> + <col class="title" /> + </colgroup> - <tbody> - <tr> - <th colspan="2"> - <h2 id="section-main-functions" class="hasAnchor"><a href="#section-main-functions" class="anchor"></a>Main functions</h2> - <p class="section-desc"><p>Essential functionality</p></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="mkinmod.html">mkinmod</a></code> </p> - </td> - <td><p>Function to set up a kinetic model with one or more state variables</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkinfit.html">mkinfit</a></code> </p> - </td> - <td><p>Fit a kinetic model to data with one or more state variables</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mmkin.html">mmkin</a></code> </p> - </td> - <td><p>Fit one or more kinetic models with one or more state variables to one or more datasets</p></td> - </tr> - </tbody><tbody> - <tr> - <th colspan="2"> - <h2 id="section-show-results" class="hasAnchor"><a href="#section-show-results" class="anchor"></a>Show results</h2> - <p class="section-desc"><p>Functions working with mkinfit objects</p></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="plot.mkinfit.html">plot.mkinfit</a></code> </p> - </td> - <td><p>Plot the observed data and the fitted model of an mkinfit object</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="summary.mkinfit.html">summary</a></code> <code><a href="summary.mkinfit.html">print</a></code> </p> - </td> - <td><p>Summary method for class "mkinfit"</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkinresplot.html">mkinresplot</a></code> </p> - </td> - <td><p>Function to plot residuals stored in an mkin object</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkinparplot.html">mkinparplot</a></code> </p> - </td> - <td><p>Function to plot the confidence intervals obtained using mkinfit</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="endpoints.html">endpoints</a></code> </p> - </td> - <td><p>Function to calculate endpoints for further use from kinetic models fitted with mkinfit</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkinerrmin.html">mkinerrmin</a></code> </p> - </td> - <td><p>Calculate the minimum error to assume in order to pass the variance test</p></td> - </tr> - </tbody><tbody> - <tr> - <th colspan="2"> - <h2 id="section-work-with-mmkin-objects" class="hasAnchor"><a href="#section-work-with-mmkin-objects" class="anchor"></a>Work with mmkin objects</h2> - <p class="section-desc"><p>Functions working with aggregated results</p></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="Extract.mmkin.html">[.mmkin</a></code> </p> - </td> - <td><p>Subsetting method for mmkin objects</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="plot.mmkin.html">plot</a></code> </p> - </td> - <td><p>Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object</p></td> - </tr> - </tbody><tbody> - <tr> - <th colspan="2"> - <h2 id="section-datasets-and-known-results" class="hasAnchor"><a href="#section-datasets-and-known-results" class="anchor"></a>Datasets and known results</h2> - <p class="section-desc"></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="FOCUS_2006_datasets.html">FOCUS_2006_datasets</a></code> </p> - </td> - <td><p>Datasets A to F from the FOCUS Kinetics report from 2006</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="FOCUS_2006_SFO_ref_A_to_F.html">FOCUS_2006_SFO_ref_A_to_F</a></code> </p> - </td> - <td><p>Results of fitting the SFO model to Datasets A to F of FOCUS (2006)</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="FOCUS_2006_FOMC_ref_A_to_F.html">FOCUS_2006_FOMC_ref_A_to_F</a></code> </p> - </td> - <td><p>Results of fitting the FOMC model to Datasets A to F of FOCUS (2006)</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="FOCUS_2006_HS_ref_A_to_F.html">FOCUS_2006_HS_ref_A_to_F</a></code> </p> - </td> - <td><p>Results of fitting the HS model to Datasets A to F of FOCUS (2006)</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="FOCUS_2006_DFOP_ref_A_to_B.html">FOCUS_2006_DFOP_ref_A_to_B</a></code> </p> - </td> - <td><p>Results of fitting the DFOP model to Datasets A to B of FOCUS (2006)</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mccall81_245T.html">mccall81_245T</a></code> </p> - </td> - <td><p>Datasets on aerobic soil metabolism of 2,4,5-T in six soils</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="schaefer07_complex_case.html">schaefer07_complex_case</a></code> </p> - </td> - <td><p>Metabolism data set used for checking the software quality of KinGUI</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="synthetic_data_for_UBA.html">synthetic_data_for_UBA_2014</a></code> </p> - </td> - <td><p>Synthetic datasets for one parent compound with two metabolites</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="test_data_from_UBA_2014.html">test_data_from_UBA_2014</a></code> </p> - </td> - <td><p>Three experimental datasets from two water sediment systems and one soil</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkinds.html">mkinds</a></code> </p> - </td> - <td><p>A dataset class for mkin</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="print.mkinds.html">print</a></code> </p> - </td> - <td><p>Print mkinds objects</p></td> - </tr> - </tbody><tbody> - <tr> - <th colspan="2"> - <h2 id="section-helper-functions" class="hasAnchor"><a href="#section-helper-functions" class="anchor"></a>Helper functions</h2> - <p class="section-desc"></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="geometric_mean.html">geometric_mean</a></code> </p> - </td> - <td><p>Calculate the geometric mean</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkinsub.html">mkinsub</a></code> </p> - </td> - <td><p>Function to set up a kinetic submodel for one state variable</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="max_twa_parent.html">max_twa_parent</a></code> </p> - </td> - <td><p>Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkinpredict.html">mkinpredict</a></code> </p> - </td> - <td><p>Produce predictions from a kinetic model using specific parameters</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkin_wide_to_long.html">mkin_wide_to_long</a></code> </p> - </td> - <td><p>Convert a dataframe with observations over time into long format</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="mkin_long_to_wide.html">mkin_long_to_wide</a></code> </p> - </td> - <td><p>Convert a dataframe from long to wide format</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="print.mkinmod.html">print</a></code> </p> - </td> - <td><p>Print mkinmod objects</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="transform_odeparms.html">transform_odeparms</a></code> <code><a href="transform_odeparms.html">backtransform_odeparms</a></code> </p> - </td> - <td><p>Functions to transform and backtransform kinetic parameters for fitting</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="ilr.html">ilr</a></code> <code><a href="ilr.html">invilr</a></code> </p> - </td> - <td><p>Function to perform isometric log-ratio transformation</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="sigma_rl.html">sigma_rl</a></code> </p> - </td> - <td><p>Two component error model of Rocke and Lorenzato</p></td> - </tr> - </tbody><tbody> - <tr> - <th colspan="2"> - <h2 id="section-analytical-solutions" class="hasAnchor"><a href="#section-analytical-solutions" class="anchor"></a>Analytical solutions</h2> - <p class="section-desc"><p>Parent only model solutions</p></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="SFO.solution.html">SFO.solution</a></code> </p> - </td> - <td><p>Single First-Order kinetics</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="FOMC.solution.html">FOMC.solution</a></code> </p> - </td> - <td><p>First-Order Multi-Compartment kinetics</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="DFOP.solution.html">DFOP.solution</a></code> </p> - </td> - <td><p>Double First-Order in Parallel kinetics</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="SFORB.solution.html">SFORB.solution</a></code> </p> - </td> - <td><p>Single First-Order Reversible Binding kinetics</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="HS.solution.html">HS.solution</a></code> </p> - </td> - <td><p>Hockey-Stick kinetics</p></td> - </tr><tr> - <!-- --> - <td> - <p><code><a href="IORE.solution.html">IORE.solution</a></code> </p> - </td> - <td><p>Indeterminate order rate equation kinetics</p></td> - </tr> - </tbody><tbody> - <tr> - <th colspan="2"> - <h2 id="section-generate-synthetic-datasets" class="hasAnchor"><a href="#section-generate-synthetic-datasets" class="anchor"></a>Generate synthetic datasets</h2> - <p class="section-desc"></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="add_err.html">add_err</a></code> </p> - </td> - <td><p>Add normally distributed errors to simulated kinetic degradation data</p></td> - </tr> - </tbody><tbody> - <tr> - <th colspan="2"> - <h2 id="section-deprecated-functions" class="hasAnchor"><a href="#section-deprecated-functions" class="anchor"></a>Deprecated functions</h2> - <p class="section-desc"><p>Functions that have been superseeded</p></p> - </th> - </tr> - <tr> - <!-- --> - <td> - <p><code><a href="mkinplot.html">mkinplot</a></code> </p> - </td> - <td><p>Plot the observed data and the fitted model of an mkinfit object</p></td> - </tr> - </tbody> - </table> - </div> + <tbody> + <tr> + <th colspan="2"> + <h2 id="section-main-functions" class="hasAnchor"><a href="#section-main-functions" class="anchor"></a>Main functions</h2> + <p class="section-desc"><p>Essential functionality</p></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="mkinmod.html">mkinmod()</a></code> </p> + </td> + <td><p>Function to set up a kinetic model with one or more state variables</p></td> + </tr><tr> + + <td> + <p><code><a href="mkinfit.html">mkinfit()</a></code> </p> + </td> + <td><p>Fit a kinetic model to data with one or more state variables</p></td> + </tr><tr> + + <td> + <p><code><a href="mmkin.html">mmkin()</a></code> </p> + </td> + <td><p>Fit one or more kinetic models with one or more state variables to one or more datasets</p></td> + </tr> + </tbody><tbody> + <tr> + <th colspan="2"> + <h2 id="section-show-results" class="hasAnchor"><a href="#section-show-results" class="anchor"></a>Show results</h2> + <p class="section-desc"><p>Functions working with mkinfit objects</p></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="plot.mkinfit.html">plot(<i><mkinfit></i>)</a></code> <code><a href="plot.mkinfit.html">plot_sep()</a></code> </p> + </td> + <td><p>Plot the observed data and the fitted model of an mkinfit object</p></td> + </tr><tr> + + <td> + <p><code><a href="summary.mkinfit.html">summary(<i><mkinfit></i>)</a></code> <code><a href="summary.mkinfit.html">print(<i><summary.mkinfit></i>)</a></code> </p> + </td> + <td><p>Summary method for class "mkinfit"</p></td> + </tr><tr> + + <td> + <p><code><a href="mkinresplot.html">mkinresplot()</a></code> </p> + </td> + <td><p>Function to plot residuals stored in an mkin object</p></td> + </tr><tr> + + <td> + <p><code><a href="mkinparplot.html">mkinparplot()</a></code> </p> + </td> + <td><p>Function to plot the confidence intervals obtained using mkinfit</p></td> + </tr><tr> + + <td> + <p><code><a href="endpoints.html">endpoints()</a></code> </p> + </td> + <td><p>Function to calculate endpoints for further use from kinetic models fitted with mkinfit</p></td> + </tr><tr> + + <td> + <p><code><a href="mkinerrmin.html">mkinerrmin()</a></code> </p> + </td> + <td><p>Calculate the minimum error to assume in order to pass the variance test</p></td> + </tr> + </tbody><tbody> + <tr> + <th colspan="2"> + <h2 id="section-work-with-mmkin-objects" class="hasAnchor"><a href="#section-work-with-mmkin-objects" class="anchor"></a>Work with mmkin objects</h2> + <p class="section-desc"><p>Functions working with aggregated results</p></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="Extract.mmkin.html">`[`(<i><mmkin></i>)</a></code> </p> + </td> + <td><p>Subsetting method for mmkin objects</p></td> + </tr><tr> + + <td> + <p><code><a href="plot.mmkin.html">plot(<i><mmkin></i>)</a></code> </p> + </td> + <td><p>Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object</p></td> + </tr> + </tbody><tbody> + <tr> + <th colspan="2"> + <h2 id="section-datasets-and-known-results" class="hasAnchor"><a href="#section-datasets-and-known-results" class="anchor"></a>Datasets and known results</h2> + <p class="section-desc"></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="FOCUS_2006_datasets.html">FOCUS_2006_datasets</a></code> </p> + </td> + <td><p>Datasets A to F from the FOCUS Kinetics report from 2006</p></td> + </tr><tr> + + <td> + <p><code><a href="FOCUS_2006_SFO_ref_A_to_F.html">FOCUS_2006_SFO_ref_A_to_F</a></code> </p> + </td> + <td><p>Results of fitting the SFO model to Datasets A to F of FOCUS (2006)</p></td> + </tr><tr> + + <td> + <p><code><a href="FOCUS_2006_FOMC_ref_A_to_F.html">FOCUS_2006_FOMC_ref_A_to_F</a></code> </p> + </td> + <td><p>Results of fitting the FOMC model to Datasets A to F of FOCUS (2006)</p></td> + </tr><tr> + + <td> + <p><code><a href="FOCUS_2006_HS_ref_A_to_F.html">FOCUS_2006_HS_ref_A_to_F</a></code> </p> + </td> + <td><p>Results of fitting the HS model to Datasets A to F of FOCUS (2006)</p></td> + </tr><tr> + + <td> + <p><code><a href="FOCUS_2006_DFOP_ref_A_to_B.html">FOCUS_2006_DFOP_ref_A_to_B</a></code> </p> + </td> + <td><p>Results of fitting the DFOP model to Datasets A to B of FOCUS (2006)</p></td> + </tr><tr> + + <td> + <p><code><a href="mccall81_245T.html">mccall81_245T</a></code> </p> + </td> + <td><p>Datasets on aerobic soil metabolism of 2,4,5-T in six soils</p></td> + </tr><tr> + + <td> + <p><code><a href="schaefer07_complex_case.html">schaefer07_complex_case</a></code> </p> + </td> + <td><p>Metabolism data set used for checking the software quality of KinGUI</p></td> + </tr><tr> + + <td> + <p><code><a href="synthetic_data_for_UBA.html">synthetic_data_for_UBA_2014</a></code> </p> + </td> + <td><p>Synthetic datasets for one parent compound with two metabolites</p></td> + </tr><tr> + + <td> + <p><code><a href="test_data_from_UBA_2014.html">test_data_from_UBA_2014</a></code> </p> + </td> + <td><p>Three experimental datasets from two water sediment systems and one soil</p></td> + </tr><tr> + + <td> + <p><code><a href="mkinds.html">mkinds</a></code> </p> + </td> + <td><p>A dataset class for mkin</p></td> + </tr><tr> + + <td> + <p><code><a href="print.mkinds.html">print(<i><mkinds></i>)</a></code> </p> + </td> + <td><p>Print mkinds objects</p></td> + </tr> + </tbody><tbody> + <tr> + <th colspan="2"> + <h2 id="section-helper-functions" class="hasAnchor"><a href="#section-helper-functions" class="anchor"></a>Helper functions</h2> + <p class="section-desc"></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="geometric_mean.html">geometric_mean()</a></code> </p> + </td> + <td><p>Calculate the geometric mean</p></td> + </tr><tr> + + <td> + <p><code><a href="mkinsub.html">mkinsub()</a></code> </p> + </td> + <td><p>Function to set up a kinetic submodel for one state variable</p></td> + </tr><tr> + + <td> + <p><code><a href="max_twa_parent.html">max_twa_parent()</a></code> </p> + </td> + <td><p>Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit</p></td> + </tr><tr> + + <td> + <p><code><a href="mkinpredict.html">mkinpredict()</a></code> </p> + </td> + <td><p>Produce predictions from a kinetic model using specific parameters</p></td> + </tr><tr> + + <td> + <p><code><a href="mkin_wide_to_long.html">mkin_wide_to_long()</a></code> </p> + </td> + <td><p>Convert a dataframe with observations over time into long format</p></td> + </tr><tr> + + <td> + <p><code><a href="mkin_long_to_wide.html">mkin_long_to_wide()</a></code> </p> + </td> + <td><p>Convert a dataframe from long to wide format</p></td> + </tr><tr> + + <td> + <p><code><a href="print.mkinmod.html">print(<i><mkinmod></i>)</a></code> </p> + </td> + <td><p>Print mkinmod objects</p></td> + </tr><tr> + + <td> + <p><code><a href="transform_odeparms.html">transform_odeparms()</a></code> <code><a href="transform_odeparms.html">backtransform_odeparms()</a></code> </p> + </td> + <td><p>Functions to transform and backtransform kinetic parameters for fitting</p></td> + </tr><tr> + + <td> + <p><code><a href="ilr.html">ilr()</a></code> <code><a href="ilr.html">invilr()</a></code> </p> + </td> + <td><p>Function to perform isometric log-ratio transformation</p></td> + </tr><tr> + + <td> + <p><code><a href="sigma_rl.html">sigma_rl()</a></code> </p> + </td> + <td><p>Two component error model of Rocke and Lorenzato</p></td> + </tr> + </tbody><tbody> + <tr> + <th colspan="2"> + <h2 id="section-analytical-solutions" class="hasAnchor"><a href="#section-analytical-solutions" class="anchor"></a>Analytical solutions</h2> + <p class="section-desc"><p>Parent only model solutions</p></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="SFO.solution.html">SFO.solution()</a></code> </p> + </td> + <td><p>Single First-Order kinetics</p></td> + </tr><tr> + + <td> + <p><code><a href="FOMC.solution.html">FOMC.solution()</a></code> </p> + </td> + <td><p>First-Order Multi-Compartment kinetics</p></td> + </tr><tr> + + <td> + <p><code><a href="DFOP.solution.html">DFOP.solution()</a></code> </p> + </td> + <td><p>Double First-Order in Parallel kinetics</p></td> + </tr><tr> + + <td> + <p><code><a href="SFORB.solution.html">SFORB.solution()</a></code> </p> + </td> + <td><p>Single First-Order Reversible Binding kinetics</p></td> + </tr><tr> + + <td> + <p><code><a href="HS.solution.html">HS.solution()</a></code> </p> + </td> + <td><p>Hockey-Stick kinetics</p></td> + </tr><tr> + + <td> + <p><code><a href="IORE.solution.html">IORE.solution()</a></code> </p> + </td> + <td><p>Indeterminate order rate equation kinetics</p></td> + </tr> + </tbody><tbody> + <tr> + <th colspan="2"> + <h2 id="section-generate-synthetic-datasets" class="hasAnchor"><a href="#section-generate-synthetic-datasets" class="anchor"></a>Generate synthetic datasets</h2> + <p class="section-desc"></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="add_err.html">add_err()</a></code> </p> + </td> + <td><p>Add normally distributed errors to simulated kinetic degradation data</p></td> + </tr> + </tbody><tbody> + <tr> + <th colspan="2"> + <h2 id="section-deprecated-functions" class="hasAnchor"><a href="#section-deprecated-functions" class="anchor"></a>Deprecated functions</h2> + <p class="section-desc"><p>Functions that have been superseeded</p></p> + </th> + </tr> + <tr> + + <td> + <p><code><a href="mkinplot.html">mkinplot()</a></code> </p> + </td> + <td><p>Plot the observed data and the fitted model of an mkinfit object</p></td> + </tr> + </tbody> + </table> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> @@ -452,6 +459,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/max_twa_parent.html b/docs/reference/max_twa_parent.html index 696ca729..7b3ef8ea 100644 --- a/docs/reference/max_twa_parent.html +++ b/docs/reference/max_twa_parent.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="Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit — max_twa_parent" /> <meta property="og:description" content="This function calculates maximum moving window time weighted average concentrations @@ -35,6 +38,9 @@ calculations for the parent are implemented for the SFO, FOMC and DFOP models, using the analytical formulas given in the PEC soil section of the FOCUS guidance." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,12 @@ guidance." /> <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> @@ -99,6 +109,7 @@ guidance." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ guidance." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit</h1> + + <div class="hidden name"><code>max_twa_parent.Rd</code></div> </div> + <div class="ref-description"> <p>This function calculates maximum moving window time weighted average concentrations (TWAs) for kinetic models fitted with <code><a href='mkinfit.html'>mkinfit</a></code>. Currently, only @@ -119,10 +133,11 @@ calculations for the parent are implemented for the SFO, FOMC and DFOP models, using the analytical formulas given in the PEC soil section of the FOCUS guidance.</p> + </div> <pre class="usage"><span class='fu'>max_twa_parent</span>(<span class='no'>fit</span>, <span class='no'>windows</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> @@ -184,6 +199,8 @@ guidance.</p> </footer> </div> + + </body> </html> diff --git a/docs/reference/mccall81_245T.html b/docs/reference/mccall81_245T.html index cb70e68c..3326a225 100644 --- a/docs/reference/mccall81_245T.html +++ b/docs/reference/mccall81_245T.html @@ -21,18 +21,24 @@ <!-- 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="Datasets on aerobic soil metabolism of 2,4,5-T in six soils — mccall81_245T" /> <meta property="og:description" content="Time course of 2,4,5-trichlorophenoxyacetic acid, and the corresponding 2,4,5-trichlorophenol and 2,4,5-trichloroanisole as recovered in diethylether extracts." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -55,8 +61,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> @@ -97,6 +107,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -104,17 +115,21 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Datasets on aerobic soil metabolism of 2,4,5-T in six soils</h1> + + <div class="hidden name"><code>mccall81_245T.Rd</code></div> </div> + <div class="ref-description"> <p>Time course of 2,4,5-trichlorophenoxyacetic acid, and the corresponding 2,4,5-trichlorophenol and 2,4,5-trichloroanisole as recovered in diethylether extracts.</p> + </div> <pre class="usage"><span class='no'>mccall81_245T</span></pre> @@ -150,9 +165,9 @@ <span class='kw'>parms.ini</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='kw'>k_phenol_sink</span> <span class='kw'>=</span> <span class='fl'>0</span>), <span class='kw'>fixed_parms</span> <span class='kw'>=</span> <span class='st'>"k_phenol_sink"</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) <span class='fu'>summary</span>(<span class='no'>fit.2</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='fl'>FALSE</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:30 2018 -#> Date of summary: Wed Mar 21 18:14:30 2018 +#> R version used for fitting: 3.5.0 +#> Date of fit: Wed Jun 6 01:21:34 2018 +#> Date of summary: Wed Jun 6 01:21:34 2018 #> #> Equations: #> d_T245/dt = - k_T245_sink * T245 - k_T245_phenol * T245 @@ -162,7 +177,7 @@ #> #> Model predictions using solution type deSolve #> -#> Fitted with method Port using 246 model solutions performed in 1.403 s +#> Fitted with method Port using 246 model solutions performed in 1.452 s #> #> Weighting: none #> @@ -270,6 +285,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mkin_long_to_wide.html b/docs/reference/mkin_long_to_wide.html index 3c498a76..7f4431f5 100644 --- a/docs/reference/mkin_long_to_wide.html +++ b/docs/reference/mkin_long_to_wide.html @@ -21,18 +21,24 @@ <!-- 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="Convert a dataframe from long to wide format — mkin_long_to_wide" /> <meta property="og:description" content="This function takes a dataframe in the long form as required by modCost and converts it into a dataframe with one independent variable and several dependent variables as columns." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -55,8 +61,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> @@ -97,6 +107,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -104,21 +115,25 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Convert a dataframe from long to wide format</h1> + + <div class="hidden name"><code>mkin_long_to_wide.Rd</code></div> </div> + <div class="ref-description"> <p>This function takes a dataframe in the long form as required by <code>modCost</code> and converts it into a dataframe with one independent variable and several dependent variables as columns.</p> + </div> <pre class="usage"><span class='fu'>mkin_long_to_wide</span>(<span class='no'>long_data</span>, <span class='kw'>time</span> <span class='kw'>=</span> <span class='st'>"time"</span>, <span class='kw'>outtime</span> <span class='kw'>=</span> <span class='st'>"time"</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> @@ -196,6 +211,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mkin_wide_to_long.html b/docs/reference/mkin_wide_to_long.html index f40cb7cf..d52f582b 100644 --- a/docs/reference/mkin_wide_to_long.html +++ b/docs/reference/mkin_wide_to_long.html @@ -21,17 +21,23 @@ <!-- 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="Convert a dataframe with observations over time into long format — mkin_wide_to_long" /> <meta property="og:description" content="This function simply takes a dataframe with one independent variable and several dependent variable and converts it into the long form as required by modCost." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,20 +114,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Convert a dataframe with observations over time into long format</h1> + + <div class="hidden name"><code>mkin_wide_to_long.Rd</code></div> </div> + <div class="ref-description"> <p>This function simply takes a dataframe with one independent variable and several dependent variable and converts it into the long form as required by <code>modCost</code>.</p> + </div> <pre class="usage"><span class='fu'>mkin_wide_to_long</span>(<span class='no'>wide_data</span>, <span class='kw'>time</span> <span class='kw'>=</span> <span class='st'>"t"</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> @@ -174,6 +189,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mkinds.html b/docs/reference/mkinds.html index 7f5ec78e..43cd51f7 100644 --- a/docs/reference/mkinds.html +++ b/docs/reference/mkinds.html @@ -21,16 +21,22 @@ <!-- 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="A dataset class for mkin — mkinds" /> <meta property="og:description" content="A dataset class for mkin" /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,15 +113,19 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>A dataset class for mkin</h1> + + <div class="hidden name"><code>mkinds.Rd</code></div> </div> + <div class="ref-description"> <p>A dataset class for mkin</p> + </div> <pre class="usage"><span class='no'>mkinds</span></pre> @@ -162,6 +177,8 @@ in order to be compatible with mkinfit</p></dd> </footer> </div> + + </body> </html> diff --git a/docs/reference/mkinerrmin.html b/docs/reference/mkinerrmin.html index f172cba1..e6fd8807 100644 --- a/docs/reference/mkinerrmin.html +++ b/docs/reference/mkinerrmin.html @@ -21,17 +21,23 @@ <!-- 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="Calculate the minimum error to assume in order to pass the variance test — mkinerrmin" /> <meta property="og:description" content="This function finds the smallest relative error still resulting in passing the chi-squared test as defined in the FOCUS kinetics report from 2006." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,12 @@ chi-squared test as defined in the FOCUS kinetics report from 2006." /> <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> @@ -96,6 +106,7 @@ chi-squared test as defined in the FOCUS kinetics report from 2006." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,20 +114,24 @@ chi-squared test as defined in the FOCUS kinetics report from 2006." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Calculate the minimum error to assume in order to pass the variance test</h1> + + <div class="hidden name"><code>mkinerrmin.Rd</code></div> </div> + <div class="ref-description"> <p>This function finds the smallest relative error still resulting in passing the chi-squared test as defined in the FOCUS kinetics report from 2006.</p> + </div> <pre class="usage"><span class='fu'>mkinerrmin</span>(<span class='no'>fit</span>, <span class='kw'>alpha</span> <span class='kw'>=</span> <span class='fl'>0.05</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> @@ -198,6 +213,8 @@ chi-squared test as defined in the FOCUS kinetics report from 2006.</p> </footer> </div> + + </body> </html> 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> diff --git a/docs/reference/mkinmod.html b/docs/reference/mkinmod.html index 7d3c0f94..04050367 100644 --- a/docs/reference/mkinmod.html +++ b/docs/reference/mkinmod.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="Function to set up a kinetic model with one or more state variables — mkinmod" /> <meta property="og:description" content="The function usually takes several expressions, each assigning a compound name to @@ -36,6 +39,9 @@ For the definition of model types and their parameters, the equations given in the FOCUS and NAFTA guidance documents are used." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -58,8 +64,12 @@ For the definition of model types and their parameters, the equations given <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> @@ -100,6 +110,7 @@ For the definition of model types and their parameters, the equations given <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -107,12 +118,15 @@ For the definition of model types and their parameters, the equations given </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Function to set up a kinetic model with one or more state variables</h1> + + <div class="hidden name"><code>mkinmod.Rd</code></div> </div> + <div class="ref-description"> <p>The function usually takes several expressions, each assigning a compound name to a list, specifying the kinetic model type and reaction or transfer to other @@ -121,10 +135,11 @@ For the definition of model types and their parameters, the equations given <p>For the definition of model types and their parameters, the equations given in the FOCUS and NAFTA guidance documents are used.</p> + </div> <pre class="usage"><span class='fu'>mkinmod</span>(<span class='no'>...</span>, <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"min"</span>, <span class='kw'>speclist</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>verbose</span> <span class='kw'>=</span> <span class='fl'>FALSE</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> @@ -262,6 +277,8 @@ For the definition of model types and their parameters, the equations given </footer> </div> + + </body> </html> diff --git a/docs/reference/mkinparplot-1.png b/docs/reference/mkinparplot-1.png Binary files differindex 1e7603d7..ba7212c5 100644 --- a/docs/reference/mkinparplot-1.png +++ b/docs/reference/mkinparplot-1.png diff --git a/docs/reference/mkinparplot.html b/docs/reference/mkinparplot.html index 81f52fc3..5a843c0e 100644 --- a/docs/reference/mkinparplot.html +++ b/docs/reference/mkinparplot.html @@ -21,17 +21,23 @@ <!-- 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="Function to plot the confidence intervals obtained using mkinfit — mkinparplot" /> <meta property="og:description" content="This function plots the confidence intervals for the parameters fitted using mkinfit." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,20 +114,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Function to plot the confidence intervals obtained using mkinfit</h1> + + <div class="hidden name"><code>mkinparplot.Rd</code></div> </div> + <div class="ref-description"> <p>This function plots the confidence intervals for the parameters fitted using <code><a href='mkinfit.html'>mkinfit</a></code>.</p> + </div> <pre class="usage"><span class='fu'>mkinparplot</span>(<span class='no'>object</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> @@ -135,7 +150,7 @@ <span class='kw'>T245</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='kw'>to</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"phenol"</span>), <span class='kw'>sink</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>), <span class='kw'>phenol</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='kw'>to</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"anisole"</span>)), <span class='kw'>anisole</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>), <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</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='no'>fit</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>model</span>, <span class='fu'>subset</span>(<span class='no'>mccall81_245T</span>, <span class='no'>soil</span> <span class='kw'>==</span> <span class='st'>"Commerce"</span>), <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) -<span class='fu'>mkinparplot</span>(<span class='no'>fit</span>)</div><div class='img'><img src='mkinparplot-1.png' alt='' width='700' height='432.632880098887' /></div></pre> +<span class='fu'>mkinparplot</span>(<span class='no'>fit</span>)</div><div class='img'><img src='mkinparplot-1.png' alt='' width='700' height='433' /></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -166,6 +181,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mkinplot.html b/docs/reference/mkinplot.html index cfd72521..3a55ceae 100644 --- a/docs/reference/mkinplot.html +++ b/docs/reference/mkinplot.html @@ -21,16 +21,22 @@ <!-- 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="Plot the observed data and the fitted model of an mkinfit object — mkinplot" /> <meta property="og:description" content="Deprecated function. It now only calls the plot method plot.mkinfit." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,19 +113,23 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Plot the observed data and the fitted model of an mkinfit object</h1> + + <div class="hidden name"><code>mkinplot.Rd</code></div> </div> + <div class="ref-description"> <p>Deprecated function. It now only calls the plot method <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code>.</p> + </div> <pre class="usage"><span class='fu'>mkinplot</span>(<span class='no'>fit</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> @@ -160,6 +175,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mkinpredict.html b/docs/reference/mkinpredict.html index 4768215b..946e0dfc 100644 --- a/docs/reference/mkinpredict.html +++ b/docs/reference/mkinpredict.html @@ -21,18 +21,24 @@ <!-- 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="Produce predictions from a kinetic model using specific parameters — mkinpredict" /> <meta property="og:description" content="This function produces a time series for all the observed variables in a kinetic model as specified by mkinmod, using a specific set of kinetic parameters and initial values for the state variables." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -55,8 +61,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> @@ -97,6 +107,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -104,23 +115,27 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Produce predictions from a kinetic model using specific parameters</h1> + + <div class="hidden name"><code>mkinpredict.Rd</code></div> </div> + <div class="ref-description"> <p>This function produces a time series for all the observed variables in a kinetic model as specified by <code><a href='mkinmod.html'>mkinmod</a></code>, using a specific set of kinetic parameters and initial values for the state variables.</p> + </div> <pre class="usage"><span class='fu'>mkinpredict</span>(<span class='no'>mkinmod</span>, <span class='no'>odeparms</span>, <span class='no'>odeini</span>, <span class='no'>outtimes</span>, <span class='kw'>solution_type</span> <span class='kw'>=</span> <span class='st'>"deSolve"</span>, <span class='kw'>use_compiled</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>method.ode</span> <span class='kw'>=</span> <span class='st'>"lsoda"</span>, <span class='kw'>atol</span> <span class='kw'>=</span> <span class='fl'>1e-08</span>, <span class='kw'>rtol</span> <span class='kw'>=</span> <span class='fl'>1e-10</span>, <span class='kw'>map_output</span> <span class='kw'>=</span> <span class='fl'>TRUE</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> @@ -305,18 +320,18 @@ <span class='fu'>print</span>(<span class='fu'>mkinpredict</span>(<span class='no'>SFO_SFO</span>, <span class='fu'>c</span>(<span class='kw'>k_parent_m1</span> <span class='kw'>=</span> <span class='fl'>0.05</span>, <span class='kw'>k_parent_sink</span> <span class='kw'>=</span> <span class='fl'>0.1</span>, <span class='kw'>k_m1_sink</span> <span class='kw'>=</span> <span class='fl'>0.01</span>), <span class='fu'>c</span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fl'>100</span>, <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fl'>0</span>), <span class='fu'>seq</span>(<span class='fl'>0</span>, <span class='fl'>20</span>, <span class='kw'>by</span> <span class='kw'>=</span> <span class='fl'>0.1</span>), <span class='kw'>solution_type</span> <span class='kw'>=</span> <span class='st'>"eigen"</span>)[<span class='fl'>201</span>,]))</div><div class='output co'>#> time parent m1 -#> 201 20 4.978707 27.46227</div><div class='output co'>#> user system elapsed -#> 0.003 0.000 0.003 </div><div class='input'> <span class='fu'>system.time</span>( +#> 201 20 4.978707 27.46227</div><div class='output co'>#> User System verstrichen +#> 0.004 0.000 0.004 </div><div class='input'> <span class='fu'>system.time</span>( <span class='fu'>print</span>(<span class='fu'>mkinpredict</span>(<span class='no'>SFO_SFO</span>, <span class='fu'>c</span>(<span class='kw'>k_parent_m1</span> <span class='kw'>=</span> <span class='fl'>0.05</span>, <span class='kw'>k_parent_sink</span> <span class='kw'>=</span> <span class='fl'>0.1</span>, <span class='kw'>k_m1_sink</span> <span class='kw'>=</span> <span class='fl'>0.01</span>), <span class='fu'>c</span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fl'>100</span>, <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fl'>0</span>), <span class='fu'>seq</span>(<span class='fl'>0</span>, <span class='fl'>20</span>, <span class='kw'>by</span> <span class='kw'>=</span> <span class='fl'>0.1</span>), <span class='kw'>solution_type</span> <span class='kw'>=</span> <span class='st'>"deSolve"</span>)[<span class='fl'>201</span>,]))</div><div class='output co'>#> time parent m1 -#> 201 20 4.978707 27.46227</div><div class='output co'>#> user system elapsed -#> 0.002 0.000 0.001 </div><div class='input'> <span class='fu'>system.time</span>( +#> 201 20 4.978707 27.46227</div><div class='output co'>#> User System verstrichen +#> 0.002 0.000 0.002 </div><div class='input'> <span class='fu'>system.time</span>( <span class='fu'>print</span>(<span class='fu'>mkinpredict</span>(<span class='no'>SFO_SFO</span>, <span class='fu'>c</span>(<span class='kw'>k_parent_m1</span> <span class='kw'>=</span> <span class='fl'>0.05</span>, <span class='kw'>k_parent_sink</span> <span class='kw'>=</span> <span class='fl'>0.1</span>, <span class='kw'>k_m1_sink</span> <span class='kw'>=</span> <span class='fl'>0.01</span>), <span class='fu'>c</span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fl'>100</span>, <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fl'>0</span>), <span class='fu'>seq</span>(<span class='fl'>0</span>, <span class='fl'>20</span>, <span class='kw'>by</span> <span class='kw'>=</span> <span class='fl'>0.1</span>), <span class='kw'>solution_type</span> <span class='kw'>=</span> <span class='st'>"deSolve"</span>, <span class='kw'>use_compiled</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)[<span class='fl'>201</span>,]))</div><div class='output co'>#> time parent m1 -#> 201 20 4.978707 27.46227</div><div class='output co'>#> user system elapsed -#> 0.033 0.000 0.032 </div></pre> +#> 201 20 4.978707 27.46227</div><div class='output co'>#> User System verstrichen +#> 0.035 0.000 0.035 </div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -347,6 +362,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mkinresplot-1.png b/docs/reference/mkinresplot-1.png Binary files differindex 5b201616..b53869c7 100644 --- a/docs/reference/mkinresplot-1.png +++ b/docs/reference/mkinresplot-1.png diff --git a/docs/reference/mkinresplot.html b/docs/reference/mkinresplot.html index df83f693..c288bf7c 100644 --- a/docs/reference/mkinresplot.html +++ b/docs/reference/mkinresplot.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="Function to plot residuals stored in an mkin object — mkinresplot" /> <meta property="og:description" content="This function plots the residuals for the specified subset of the @@ -34,6 +37,9 @@ model and the residuals can be obtained using plot.mkinfit using the argument show_residuals = TRUE." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -56,8 +62,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> @@ -98,6 +108,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -105,18 +116,22 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Function to plot residuals stored in an mkin object</h1> + + <div class="hidden name"><code>mkinresplot.Rd</code></div> </div> + <div class="ref-description"> <p>This function plots the residuals for the specified subset of the observed variables from an mkinfit object. A combined plot of the fitted model and the residuals can be obtained using <code><a href='plot.mkinfit.html'>plot.mkinfit</a></code> using the argument <code>show_residuals = TRUE</code>.</p> + </div> <pre class="usage"><span class='fu'>mkinresplot</span>(<span class='no'>object</span>, <span class='kw'>obs_vars</span> <span class='kw'>=</span> <span class='fu'>names</span>(<span class='no'>object</span>$<span class='no'>mkinmod</span>$<span class='no'>map</span>), @@ -124,7 +139,7 @@ <span class='kw'>xlab</span> <span class='kw'>=</span> <span class='st'>"Time"</span>, <span class='kw'>ylab</span> <span class='kw'>=</span> <span class='st'>"Residual"</span>, <span class='kw'>maxabs</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>legend</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>lpos</span> <span class='kw'>=</span> <span class='st'>"topright"</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> @@ -174,13 +189,13 @@ <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2> - <p><code><a href='mkinplot.html'>mkinplot</a></code>, for a way to plot the data and the fitted lines of the - mkinfit object.</p> + <div class='dont-index'><p><code><a href='mkinplot.html'>mkinplot</a></code>, for a way to plot the data and the fitted lines of the + mkinfit object.</p></div> <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> <pre class="examples"><div class='input'><span class='no'>model</span> <span class='kw'><-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<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='no'>fit</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>model</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) -<span class='fu'>mkinresplot</span>(<span class='no'>fit</span>, <span class='st'>"m1"</span>)</div><div class='img'><img src='mkinresplot-1.png' alt='' width='700' height='432.632880098887' /></div></pre> +<span class='fu'>mkinresplot</span>(<span class='no'>fit</span>, <span class='st'>"m1"</span>)</div><div class='img'><img src='mkinresplot-1.png' alt='' width='700' height='433' /></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -213,6 +228,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mkinsub.html b/docs/reference/mkinsub.html index db727427..9f98a077 100644 --- a/docs/reference/mkinsub.html +++ b/docs/reference/mkinsub.html @@ -21,17 +21,23 @@ <!-- 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="Function to set up a kinetic submodel for one state variable — mkinsub" /> <meta property="og:description" content="This is a convenience function to set up the lists used as arguments for mkinmod." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,20 +114,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Function to set up a kinetic submodel for one state variable</h1> + + <div class="hidden name"><code>mkinsub.Rd</code></div> </div> + <div class="ref-description"> <p>This is a convenience function to set up the lists used as arguments for <code><a href='mkinmod.html'>mkinmod</a></code>.</p> + </div> <pre class="usage"><span class='fu'>mkinsub</span>(<span class='no'>submodel</span>, <span class='kw'>to</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>sink</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>full_name</span> <span class='kw'>=</span> <span class='fl'>NA</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> @@ -191,6 +206,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/mmkin.html b/docs/reference/mmkin.html index 6c99f07b..74b6adad 100644 --- a/docs/reference/mmkin.html +++ b/docs/reference/mmkin.html @@ -21,17 +21,23 @@ <!-- 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 one or more kinetic models with one or more state variables to one or more datasets — mmkin" /> <meta property="og:description" content="This function calls mkinfit on all combinations of models and datasets specified in its first two arguments." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,21 +114,25 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Fit one or more kinetic models with one or more state variables to one or more datasets</h1> + + <div class="hidden name"><code>mmkin.Rd</code></div> </div> + <div class="ref-description"> <p>This function calls <code><a href='mkinfit.html'>mkinfit</a></code> on all combinations of models and datasets specified in its first two arguments.</p> + </div> <pre class="usage"><span class='fu'>mmkin</span>(<span class='no'>models</span>, <span class='no'>datasets</span>, <span class='kw'>cores</span> <span class='kw'>=</span> <span class='fu'>round</span>(<span class='fu'>detectCores</span>()/<span class='fl'>2</span>), <span class='kw'>cluster</span> <span class='kw'>=</span> <span class='kw'>NULL</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> @@ -156,7 +171,7 @@ <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2> - <p><code><a href='Extract.mmkin.html'>[.mmkin</a></code> for subsetting, <code><a href='plot.mmkin.html'>plot.mmkin</a></code> for plotting.</p> + <div class='dont-index'><p><code><a href='Extract.mmkin.html'>[.mmkin</a></code> for subsetting, <code><a href='plot.mmkin.html'>plot.mmkin</a></code> for plotting.</p></div> <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> @@ -225,6 +240,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/plot.mkinfit-1.png b/docs/reference/plot.mkinfit-1.png Binary files differindex 0d54d2fe..f7404448 100644 --- a/docs/reference/plot.mkinfit-1.png +++ b/docs/reference/plot.mkinfit-1.png diff --git a/docs/reference/plot.mkinfit-2.png b/docs/reference/plot.mkinfit-2.png Binary files differindex 377d63b6..93c9efe0 100644 --- a/docs/reference/plot.mkinfit-2.png +++ b/docs/reference/plot.mkinfit-2.png diff --git a/docs/reference/plot.mkinfit-3.png b/docs/reference/plot.mkinfit-3.png Binary files differindex b23ddfe7..7b8a81e2 100644 --- a/docs/reference/plot.mkinfit-3.png +++ b/docs/reference/plot.mkinfit-3.png diff --git a/docs/reference/plot.mkinfit-4.png b/docs/reference/plot.mkinfit-4.png Binary files differindex 0dd9f4d6..d44b6f9f 100644 --- a/docs/reference/plot.mkinfit-4.png +++ b/docs/reference/plot.mkinfit-4.png diff --git a/docs/reference/plot.mkinfit.html b/docs/reference/plot.mkinfit.html index 319ba75b..525a8453 100644 --- a/docs/reference/plot.mkinfit.html +++ b/docs/reference/plot.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="Plot the observed data and the fitted model of an mkinfit object — plot.mkinfit" /> <meta property="og:description" content="Solves the differential equations with the optimised and fixed parameters @@ -36,6 +39,9 @@ If the current plot device is a tikz device, then latex is being used for the formatting of the chi2 error level, if show_errmin = TRUE." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -58,8 +64,12 @@ If the current plot device is a tikz device, <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> @@ -100,6 +110,7 @@ If the current plot device is a tikz device, <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -107,12 +118,15 @@ If the current plot device is a tikz device, </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Plot the observed data and the fitted model of an mkinfit object</h1> + + <div class="hidden name"><code>plot.mkinfit.Rd</code></div> </div> + <div class="ref-description"> <p>Solves the differential equations with the optimised and fixed parameters from a previous successful call to <code><a href='mkinfit.html'>mkinfit</a></code> and plots @@ -121,6 +135,7 @@ If the current plot device is a tikz device, then latex is being used for the formatting of the chi2 error level, if <code>show_errmin = TRUE</code>.</p> + </div> <pre class="usage"># S3 method for mkinfit plot(x, fit = x, @@ -137,7 +152,7 @@ plot(x, fit = x, show_errmin = FALSE, errmin_digits = 3, …) plot_sep(fit, sep_obs = TRUE, show_residuals = TRUE, show_errmin = TRUE, …)</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> @@ -244,12 +259,12 @@ plot_sep(fit, sep_obs = TRUE, show_residuals = TRUE, show_errmin = TRUE, … <span class='co'># parent to sink included, use Levenberg-Marquardt for speed</span> <span class='no'>SFO_SFO</span> <span class='kw'><-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<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'>full</span> <span class='kw'>=</span> <span class='st'>"Parent"</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>, <span class='kw'>full</span> <span class='kw'>=</span> <span class='st'>"Metabolite M1"</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='no'>fit</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>SFO_SFO</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>method.modFit</span> <span class='kw'>=</span> <span class='st'>"Marq"</span>) -<span class='fu'>plot</span>(<span class='no'>fit</span>)</div><div class='img'><img src='plot.mkinfit-1.png' alt='' width='700' height='432.632880098887' /></div><div class='input'><span class='fu'>plot</span>(<span class='no'>fit</span>, <span class='kw'>show_residuals</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='img'><img src='plot.mkinfit-2.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> +<span class='fu'>plot</span>(<span class='no'>fit</span>)</div><div class='img'><img src='plot.mkinfit-1.png' alt='' width='700' height='433' /></div><div class='input'><span class='fu'>plot</span>(<span class='no'>fit</span>, <span class='kw'>show_residuals</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='img'><img src='plot.mkinfit-2.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># Show the observed variables separately</span> -<span class='fu'>plot</span>(<span class='no'>fit</span>, <span class='kw'>sep_obs</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>lpos</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"topright"</span>, <span class='st'>"bottomright"</span>))</div><div class='img'><img src='plot.mkinfit-3.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> +<span class='fu'>plot</span>(<span class='no'>fit</span>, <span class='kw'>sep_obs</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>lpos</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"topright"</span>, <span class='st'>"bottomright"</span>))</div><div class='img'><img src='plot.mkinfit-3.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># Show the observed variables separately, with residuals</span> <span class='fu'>plot</span>(<span class='no'>fit</span>, <span class='kw'>sep_obs</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>show_residuals</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>lpos</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"topright"</span>, <span class='st'>"bottomright"</span>), - <span class='kw'>show_errmin</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='img'><img src='plot.mkinfit-4.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> + <span class='kw'>show_errmin</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)</div><div class='img'><img src='plot.mkinfit-4.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># The same can be obtained with less typing, using the convenience function plot_sep</span> <span class='fu'>plot_sep</span>(<span class='no'>fit</span>, <span class='kw'>lpos</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"topright"</span>, <span class='st'>"bottomright"</span>))</div></pre> </div> @@ -282,6 +297,8 @@ plot_sep(fit, sep_obs = TRUE, show_residuals = TRUE, show_errmin = TRUE, … </footer> </div> + + </body> </html> diff --git a/docs/reference/plot.mmkin-1.png b/docs/reference/plot.mmkin-1.png Binary files differindex c2c25e90..2aa7aad9 100644 --- a/docs/reference/plot.mmkin-1.png +++ b/docs/reference/plot.mmkin-1.png diff --git a/docs/reference/plot.mmkin-2.png b/docs/reference/plot.mmkin-2.png Binary files differindex b40ae0d5..94b1332a 100644 --- a/docs/reference/plot.mmkin-2.png +++ b/docs/reference/plot.mmkin-2.png diff --git a/docs/reference/plot.mmkin-3.png b/docs/reference/plot.mmkin-3.png Binary files differindex dfbe014f..ca78fa42 100644 --- a/docs/reference/plot.mmkin-3.png +++ b/docs/reference/plot.mmkin-3.png diff --git a/docs/reference/plot.mmkin.html b/docs/reference/plot.mmkin.html index f1aa789f..a554a489 100644 --- a/docs/reference/plot.mmkin.html +++ b/docs/reference/plot.mmkin.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="Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object — plot.mmkin" /> <meta property="og:description" content="When x is a row selected from an mmkin object ([.mmkin), the same model @@ -35,6 +38,9 @@ If the current plot device is a tikz device, then latex is being used for the formatting of the chi2 error level." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -57,8 +63,12 @@ If the current plot device is a tikz device, <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> @@ -99,6 +109,7 @@ If the current plot device is a tikz device, <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -106,12 +117,15 @@ If the current plot device is a tikz device, </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object</h1> + + <div class="hidden name"><code>plot.mmkin.Rd</code></div> </div> + <div class="ref-description"> <p>When x is a row selected from an mmkin object (<code><a href='Extract.mmkin.html'>[.mmkin</a></code>), the same model fitted for at least one dataset is shown. When it is a column, the fit of at least one model @@ -119,12 +133,13 @@ If the current plot device is a tikz device, <p>If the current plot device is a <code><a href='http://www.rdocumentation.org/packages/tikzDevice/topics/tikz'>tikz</a></code> device, then latex is being used for the formatting of the chi2 error level.</p> + </div> <pre class="usage"><span class='co'># S3 method for mmkin</span> <span class='fu'>plot</span>(<span class='no'>x</span>, <span class='kw'>main</span> <span class='kw'>=</span> <span class='st'>"auto"</span>, <span class='kw'>legends</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>errmin_var</span> <span class='kw'>=</span> <span class='st'>"All data"</span>, <span class='kw'>errmin_digits</span> <span class='kw'>=</span> <span class='fl'>3</span>, <span class='kw'>cex</span> <span class='kw'>=</span> <span class='fl'>0.7</span>, <span class='kw'>rel.height.middle</span> <span class='kw'>=</span> <span class='fl'>0.9</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> @@ -171,11 +186,11 @@ If the current plot device is a tikz device, <span class='no'>fits</span> <span class='kw'><-</span> <span class='fu'><a href='mmkin.html'>mmkin</a></span>(<span class='fu'>c</span>(<span class='st'>"FOMC"</span>, <span class='st'>"HS"</span>), <span class='fu'>list</span>(<span class='st'>"FOCUS B"</span> <span class='kw'>=</span> <span class='no'>FOCUS_2006_B</span>, <span class='st'>"FOCUS C"</span> <span class='kw'>=</span> <span class='no'>FOCUS_2006_C</span>), <span class='co'># named list for titles</span> <span class='kw'>cores</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>method.modFit</span> <span class='kw'>=</span> <span class='st'>"Marq"</span>) - <span class='fu'>plot</span>(<span class='no'>fits</span>[, <span class='st'>"FOCUS C"</span>])</div><div class='img'><img src='plot.mmkin-1.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> <span class='fu'>plot</span>(<span class='no'>fits</span>[<span class='st'>"FOMC"</span>, ])</div><div class='img'><img src='plot.mmkin-2.png' alt='' width='700' height='432.632880098887' /></div><div class='input'> + <span class='fu'>plot</span>(<span class='no'>fits</span>[, <span class='st'>"FOCUS C"</span>])</div><div class='img'><img src='plot.mmkin-1.png' alt='' width='700' height='433' /></div><div class='input'> <span class='fu'>plot</span>(<span class='no'>fits</span>[<span class='st'>"FOMC"</span>, ])</div><div class='img'><img src='plot.mmkin-2.png' alt='' width='700' height='433' /></div><div class='input'> <span class='co'># We can also plot a single fit, if we like the way plot.mmkin works, but then the plot</span> <span class='co'># height should be smaller than the plot width (this is not possible for the html pages</span> <span class='co'># generated by pkgdown, as far as I know).</span> - <span class='fu'>plot</span>(<span class='no'>fits</span>[<span class='st'>"FOMC"</span>, <span class='st'>"FOCUS C"</span>]) <span class='co'># same as plot(fits[1, 2])</span></div><div class='img'><img src='plot.mmkin-3.png' alt='' width='700' height='432.632880098887' /></div></pre> + <span class='fu'>plot</span>(<span class='no'>fits</span>[<span class='st'>"FOMC"</span>, <span class='st'>"FOCUS C"</span>]) <span class='co'># same as plot(fits[1, 2])</span></div><div class='img'><img src='plot.mmkin-3.png' alt='' width='700' height='433' /></div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> @@ -206,6 +221,8 @@ If the current plot device is a tikz device, </footer> </div> + + </body> </html> diff --git a/docs/reference/print.mkinds.html b/docs/reference/print.mkinds.html index 2a469fc2..ade048f0 100644 --- a/docs/reference/print.mkinds.html +++ b/docs/reference/print.mkinds.html @@ -21,16 +21,22 @@ <!-- 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="Print mkinds objects — print.mkinds" /> <meta property="og:description" content="Print mkinds objects." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,20 +113,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Print mkinds objects</h1> + + <div class="hidden name"><code>print.mkinds.Rd</code></div> </div> + <div class="ref-description"> <p>Print mkinds objects.</p> + </div> <pre class="usage"><span class='co'># S3 method for mkinds</span> <span class='fu'>print</span>(<span class='no'>x</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> @@ -151,6 +166,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/print.mkinmod.html b/docs/reference/print.mkinmod.html index 30703dfd..64d3a03c 100644 --- a/docs/reference/print.mkinmod.html +++ b/docs/reference/print.mkinmod.html @@ -21,16 +21,22 @@ <!-- 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="Print mkinmod objects — print.mkinmod" /> <meta property="og:description" content="Print mkinmod objects in a way that the user finds his way to get to its components." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -53,8 +59,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> @@ -95,6 +105,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -102,20 +113,24 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Print mkinmod objects</h1> + + <div class="hidden name"><code>print.mkinmod.Rd</code></div> </div> + <div class="ref-description"> <p>Print mkinmod objects in a way that the user finds his way to get to its components.</p> + </div> <pre class="usage"><span class='co'># S3 method for mkinmod</span> <span class='fu'>print</span>(<span class='no'>x</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> @@ -172,6 +187,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/schaefer07_complex_case.html b/docs/reference/schaefer07_complex_case.html index 2c06b1dd..06b3c049 100644 --- a/docs/reference/schaefer07_complex_case.html +++ b/docs/reference/schaefer07_complex_case.html @@ -21,18 +21,24 @@ <!-- 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="Metabolism data set used for checking the software quality of KinGUI — schaefer07_complex_case" /> <meta property="og:description" content="This dataset was used for a comparison of KinGUI and ModelMaker to check the software quality of KinGUI in the original publication (Schäfer et al., 2007). The results from the fitting are also included." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -55,8 +61,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> @@ -97,6 +107,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -104,17 +115,21 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Metabolism data set used for checking the software quality of KinGUI</h1> + + <div class="hidden name"><code>schaefer07_complex_case.Rd</code></div> </div> + <div class="ref-description"> <p>This dataset was used for a comparison of KinGUI and ModelMaker to check the software quality of KinGUI in the original publication (Schäfer et al., 2007). The results from the fitting are also included.</p> + </div> <pre class="usage"><span class='no'>schaefer07_complex_case</span></pre> @@ -192,6 +207,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/sigma_rl.html b/docs/reference/sigma_rl.html index fd714224..bb9fd396 100644 --- a/docs/reference/sigma_rl.html +++ b/docs/reference/sigma_rl.html @@ -21,18 +21,24 @@ <!-- 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="Two component error model of Rocke and Lorenzato — sigma_rl" /> <meta property="og:description" content="Function describing the standard deviation of the measurement error in dependence of the measured value \(y\): $$\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}$$" /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -55,8 +61,12 @@ $$\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}$$" /> <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> @@ -97,6 +107,7 @@ $$\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}$$" /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -104,21 +115,25 @@ $$\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}$$" /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Two component error model of Rocke and Lorenzato</h1> + + <div class="hidden name"><code>sigma_rl.Rd</code></div> </div> + <div class="ref-description"> <p>Function describing the standard deviation of the measurement error in dependence of the measured value \(y\):</p> <p>$$\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}$$</p> + </div> <pre class="usage"><span class='fu'>sigma_rl</span>(<span class='no'>y</span>, <span class='no'>sigma_low</span>, <span class='no'>rsd_high</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> @@ -172,6 +187,8 @@ $$\sigma = \sqrt{ \sigma_{low}^2 + y^2 * {rsd}_{high}^2}$$" /> </footer> </div> + + </body> </html> diff --git a/docs/reference/summary.mkinfit.html b/docs/reference/summary.mkinfit.html index 37b8fff8..c8919f1c 100644 --- a/docs/reference/summary.mkinfit.html +++ b/docs/reference/summary.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="Summary method for class "mkinfit" — summary.mkinfit" /> <meta property="og:description" content="Lists model equations, the summary as returned by summary.modFit, @@ -34,6 +37,9 @@ as defined therein, and optionally the data, consisting of observed, predicted and residual values." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -56,8 +62,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> @@ -98,6 +108,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -105,25 +116,29 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Summary method for class "mkinfit"</h1> + + <div class="hidden name"><code>summary.mkinfit.Rd</code></div> </div> + <div class="ref-description"> <p>Lists model equations, the summary as returned by <code>summary.modFit</code>, the chi2 error levels calculated according to FOCUS guidance (2006) as far as defined therein, and optionally the data, consisting of observed, predicted and residual values.</p> + </div> <pre class="usage"><span class='co'># S3 method for mkinfit</span> <span class='fu'>summary</span>(<span class='no'>object</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>distimes</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>alpha</span> <span class='kw'>=</span> <span class='fl'>0.05</span>, <span class='no'>...</span>) <span class='co'># S3 method for summary.mkinfit</span> <span class='fu'>print</span>(<span class='no'>x</span>, <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fu'>max</span>(<span class='fl'>3</span>, <span class='fu'>getOption</span>(<span class='st'>"digits"</span>) - <span class='fl'>3</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> @@ -190,16 +205,16 @@ <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> <pre class="examples"><div class='input'> <span class='fu'>summary</span>(<span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<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='no'>FOCUS_2006_A</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</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:42 2018 -#> Date of summary: Wed Mar 21 18:14:42 2018 +#> R version used for fitting: 3.5.0 +#> Date of fit: Wed Jun 6 01:21:46 2018 +#> Date of summary: Wed Jun 6 01:21:46 2018 #> #> Equations: #> d_parent/dt = - k_parent_sink * parent #> #> Model predictions using solution type analytical #> -#> Fitted with method Port using 35 model solutions performed in 0.072 s +#> Fitted with method Port using 35 model solutions performed in 0.075 s #> #> Weighting: none #> @@ -291,6 +306,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/synthetic_data_for_UBA.html b/docs/reference/synthetic_data_for_UBA.html index 18da9ff6..6e0ac227 100644 --- a/docs/reference/synthetic_data_for_UBA.html +++ b/docs/reference/synthetic_data_for_UBA.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="Synthetic datasets for one parent compound with two metabolites — synthetic_data_for_UBA_2014" /> <meta property="og:description" content="The 12 datasets were generated using four different models and three different @@ -43,6 +46,9 @@ As an example, the first dataset has the title SFO_lin_a and is based on the SFO with two sequential metabolites (linear pathway), with added variance component 'a'. Compare also the code in the example section to see the degradation models." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -65,8 +71,12 @@ Compare also the code in the example section to see the degradation models." /> <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> @@ -107,6 +117,7 @@ Compare also the code in the example section to see the degradation models." /> <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -114,12 +125,15 @@ Compare also the code in the example section to see the degradation models." /> </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Synthetic datasets for one parent compound with two metabolites</h1> + + <div class="hidden name"><code>synthetic_data_for_UBA.Rd</code></div> </div> + <div class="ref-description"> <p>The 12 datasets were generated using four different models and three different variance components. The four models are either the SFO or the DFOP model with either @@ -135,6 +149,7 @@ Compare also the code in the example section to see the degradation models." /> with two sequential metabolites (linear pathway), with added variance component 'a'.</p> <p>Compare also the code in the example section to see the degradation models.</p> + </div> <pre class="usage"><span class='no'>synthetic_data_for_UBA_2014</span></pre> @@ -283,6 +298,8 @@ summary(fit) </footer> </div> + + </body> </html> diff --git a/docs/reference/test_data_from_UBA_2014.html b/docs/reference/test_data_from_UBA_2014.html index b1b5e617..090b0c22 100644 --- a/docs/reference/test_data_from_UBA_2014.html +++ b/docs/reference/test_data_from_UBA_2014.html @@ -21,17 +21,23 @@ <!-- 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="Three experimental datasets from two water sediment systems and one soil — test_data_from_UBA_2014" /> <meta property="og:description" content="The datasets were used for the comparative validation of several kinetic evaluation software packages (Ranke, 2014)." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -54,8 +60,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> @@ -96,6 +106,7 @@ <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -103,16 +114,20 @@ </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Three experimental datasets from two water sediment systems and one soil</h1> + + <div class="hidden name"><code>test_data_from_UBA_2014.Rd</code></div> </div> + <div class="ref-description"> <p>The datasets were used for the comparative validation of several kinetic evaluation software packages (Ranke, 2014).</p> + </div> <pre class="usage"><span class='no'>test_data_from_UBA_2014</span></pre> @@ -187,6 +202,8 @@ </footer> </div> + + </body> </html> diff --git a/docs/reference/transform_odeparms.html b/docs/reference/transform_odeparms.html index fb03cdac..3adb3a10 100644 --- a/docs/reference/transform_odeparms.html +++ b/docs/reference/transform_odeparms.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="Functions to transform and backtransform kinetic parameters for fitting — transform_odeparms" /> <meta property="og:description" content="The transformations are intended to map parameters that should only take @@ -39,6 +42,9 @@ The transformation of sets of formation fractions is fragile, as it supposes the same ordering of the components in forward and backward transformation. This is no problem for the internal use in mkinfit." /> <meta name="twitter:card" content="summary" /> + + + <!-- mathjax --> <script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> @@ -61,8 +67,12 @@ The transformation of sets of formation fractions is fragile, as it supposes <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> @@ -103,6 +113,7 @@ The transformation of sets of formation fractions is fragile, as it supposes <ul class="nav navbar-nav navbar-right"> </ul> + </div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> @@ -110,12 +121,15 @@ The transformation of sets of formation fractions is fragile, as it supposes </header> - <div class="row"> +<div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Functions to transform and backtransform kinetic parameters for fitting</h1> + + <div class="hidden name"><code>transform_odeparms.Rd</code></div> </div> + <div class="ref-description"> <p>The transformations are intended to map parameters that should only take on restricted values to the full scale of real numbers. For kinetic rate @@ -127,13 +141,14 @@ The transformation of sets of formation fractions is fragile, as it supposes the same ordering of the components in forward and backward transformation. This is no problem for the internal use in <code><a href='mkinfit.html'>mkinfit</a></code>.</p> + </div> <pre class="usage"><span class='fu'>transform_odeparms</span>(<span class='no'>parms</span>, <span class='no'>mkinmod</span>, <span class='kw'>transform_rates</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>transform_fractions</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>) <span class='fu'>backtransform_odeparms</span>(<span class='no'>transparms</span>, <span class='no'>mkinmod</span>, <span class='kw'>transform_rates</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>transform_fractions</span> <span class='kw'>=</span> <span class='fl'>TRUE</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> @@ -184,9 +199,9 @@ The transformation of sets of formation fractions is fragile, as it supposes <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'>list</span>(<span class='kw'>type</span> <span class='kw'>=</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='no'>fit</span> <span class='kw'><-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>SFO_SFO</span>, <span class='no'>FOCUS_2006_D</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>, <span class='kw'>data</span><span class='kw'>=</span><span class='fl'>FALSE</span>) <span class='co'># See transformed and backtransformed parameters</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:43 2018 -#> Date of summary: Wed Mar 21 18:14:43 2018 +#> R version used for fitting: 3.5.0 +#> Date of fit: Wed Jun 6 01:21:47 2018 +#> Date of summary: Wed Jun 6 01:21:47 2018 #> #> Equations: #> d_parent/dt = - k_parent_sink * parent - k_parent_m1 * parent @@ -194,7 +209,7 @@ The transformation of sets of formation fractions is fragile, as it supposes #> #> Model predictions using solution type deSolve #> -#> Fitted with method Port using 153 model solutions performed in 0.585 s +#> Fitted with method Port using 153 model solutions performed in 0.628 s #> #> Weighting: none #> @@ -322,6 +337,8 @@ The transformation of sets of formation fractions is fragile, as it supposes </footer> </div> + + </body> </html> |
