diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2023-07-21 08:24:12 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2023-07-21 08:32:32 +0200 |
| commit | d04bac001217855b4e9a1490a35bef3325441b55 (patch) | |
| tree | 26bf1a06d038c796c2dbce21e5867088c555ee06 /docs/reference/drfit.html | |
| parent | 0bc79f02e99d719be5dbb96ed1591d46c8373c9f (diff) | |
Maintenance prompted by email from CRAN
- Fix an improper use of 'packageVersion'
- Update .Rbuildignore
- Fix a link in the README
- Static documentation rebuilt by pkgdown::build_site()
Diffstat (limited to 'docs/reference/drfit.html')
| -rw-r--r-- | docs/reference/drfit.html | 455 |
1 files changed, 205 insertions, 250 deletions
diff --git a/docs/reference/drfit.html b/docs/reference/drfit.html index d707a5f..ab2fbd0 100644 --- a/docs/reference/drfit.html +++ b/docs/reference/drfit.html @@ -1,65 +1,13 @@ -<!-- Generated by pkgdown: do not edit by hand --> <!DOCTYPE html> -<html lang="en"> - <head> - <meta charset="utf-8"> -<meta http-equiv="X-UA-Compatible" content="IE=edge"> -<meta name="viewport" content="width=device-width, initial-scale=1.0"> - -<title>Fit dose-response models — drfit • drfit</title> - - -<!-- jquery --> -<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script> -<!-- Bootstrap --> - -<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" /> - -<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script> - -<!-- Font Awesome icons --> -<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" /> -<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" /> - -<!-- clipboard.js --> -<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script> - -<!-- headroom.js --> -<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script> -<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script> - -<!-- pkgdown --> -<link href="../pkgdown.css" rel="stylesheet"> -<script src="../pkgdown.js"></script> - - - - -<meta property="og:title" content="Fit dose-response models — drfit" /> -<meta property="og:description" content="Fit dose-response relationships to dose-response data and calculate - biometric results for (eco)toxicity evaluation" /> -<meta name="twitter:card" content="summary" /> - - - - -<!-- mathjax --> -<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script> -<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script> - -<!--[if lt IE 9]> +<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Fit dose-response models — drfit • drfit</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Fit dose-response models — drfit"><meta property="og:description" content="Fit dose-response relationships to dose-response data and calculate + biometric results for (eco)toxicity evaluation"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> -<![endif]--> - - - - </head> +<![endif]--></head><body data-spy="scroll" data-target="#toc"> + - <body> <div class="container template-reference-topic"> - <header> - <div class="navbar navbar-default navbar-fixed-top" role="navigation"> + <header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> @@ -70,35 +18,21 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">drfit</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.3</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.7.4</span> </span> </div> <div id="navbar" class="navbar-collapse collapse"> - <ul class="nav navbar-nav"> - <li> - <a href="../index.html"> - <span class="fas fa fas fa-home fa-lg"></span> - - </a> -</li> -<li> + <ul class="nav navbar-nav"><li> <a href="../reference/index.html">Reference</a> </li> - </ul> - <ul class="nav navbar-nav navbar-right"> - - </ul> - - </div><!--/.nav-collapse --> + </ul><ul class="nav navbar-nav navbar-right"></ul></div><!--/.nav-collapse --> </div><!--/.container --> </div><!--/.navbar --> - </header> - -<div class="row"> + </header><div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>Fit dose-response models</h1> @@ -111,220 +45,241 @@ biometric results for (eco)toxicity evaluation</p> </div> - <pre class="usage"><span class='fu'>drfit</span>(<span class='no'>data</span>, <span class='kw'>startlogED50</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>chooseone</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>probit</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>logit</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, - <span class='kw'>weibull</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>linlogit</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>level</span> <span class='kw'>=</span> <span class='fl'>0.95</span>, <span class='kw'>linlogitWrong</span> <span class='kw'>=</span> <span class='fl'>NA</span>, - <span class='kw'>allWrong</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>ps0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>ls0</span> <span class='kw'>=</span> <span class='fl'>0.5</span>, <span class='kw'>ws0</span> <span class='kw'>=</span> <span class='fl'>0.5</span>, <span class='kw'>b0</span> <span class='kw'>=</span> <span class='fl'>2</span>, <span class='kw'>f0</span> <span class='kw'>=</span> <span class='fl'>0</span>, - <span class='kw'>showED50</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, - <span class='kw'>EDx</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>EDx.tolerance</span> <span class='kw'>=</span> <span class='fl'>1e-4</span>)</pre> - - <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> - <th>data</th> - <td><p>A data frame containing dose-response data. The data frame has to contain - at least a factor called “substance”, a numeric vector “dose” - with the dose values, a vector called “unit” containing the unit - used for the dose and a numeric vector “response” with the response + <div id="ref-usage"> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">drfit</span><span class="op">(</span><span class="va">data</span>, startlogED50 <span class="op">=</span> <span class="cn">NA</span>, chooseone <span class="op">=</span> <span class="cn">TRUE</span>, probit <span class="op">=</span> <span class="cn">TRUE</span>, logit <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> weibull <span class="op">=</span> <span class="cn">FALSE</span>, linlogit <span class="op">=</span> <span class="cn">FALSE</span>, level <span class="op">=</span> <span class="fl">0.95</span>, linlogitWrong <span class="op">=</span> <span class="cn">NA</span>,</span> +<span> allWrong <span class="op">=</span> <span class="cn">NA</span>, ps0 <span class="op">=</span> <span class="fl">1</span>, ls0 <span class="op">=</span> <span class="fl">0.5</span>, ws0 <span class="op">=</span> <span class="fl">0.5</span>, b0 <span class="op">=</span> <span class="fl">2</span>, f0 <span class="op">=</span> <span class="fl">0</span>,</span> +<span> showED50 <span class="op">=</span> <span class="cn">FALSE</span>,</span> +<span> EDx <span class="op">=</span> <span class="cn">NULL</span>, EDx.tolerance <span class="op">=</span> <span class="fl">1e-4</span><span class="op">)</span></span></code></pre></div> + </div> + + <div id="arguments"> + <h2>Arguments</h2> + <dl><dt>data</dt> +<dd><p>A data frame containing dose-response data. The data frame has to contain + at least a factor called “substance”, a numeric vector “dose” + with the dose values, a vector called “unit” containing the unit + used for the dose and a numeric vector “response” with the response values of the test system normalized between 0 and 1. Such a data frame can be easily obtained if a compliant RODBC data source is available for use in - conjunction with the function <code><a href='drdata.html'>drdata</a></code>.</p> -<p>If there is a column called “ok” and it is set to “no fit” in + conjunction with the function <code><a href="drdata.html">drdata</a></code>.</p> +<p>If there is a column called “ok” and it is set to “no fit” in a specific line, then the corresponding data point will be excluded from - the fitting procedure, although it will be plotted.</p></td> - </tr> - <tr> - <th>startlogED50</th> - <td><p>Especially for the linlogit model, a suitable log10 of the ED50 has to be + the fitting procedure, although it will be plotted.</p></dd> + + <dt>startlogED50</dt> +<dd><p>Especially for the linlogit model, a suitable log10 of the ED50 has to be given by the user, since it is not correctly estimated for data showing - hormesis with the default estimation method.</p></td> - </tr> - <tr> - <th>probit</th> - <td><p>A boolean defining if cumulative density curves of normal distributions - <code><a href='https://rdrr.io/r/stats/Normal.html'>pnorm</a></code> are fitted against the decadic logarithm of the dose. - Default ist TRUE.</p></td> - </tr> - <tr> - <th>logit</th> - <td><p>A boolean defining if cumulative density curves of logistic distributions - <code><a href='https://rdrr.io/r/stats/Logistic.html'>plogis</a></code> are fitted to the decadic logarithm of the dose. - Default is FALSE.</p></td> - </tr> - <tr> - <th>weibull</th> - <td><p>A boolean defining if the cumulative density curves of weibull distributions - (<code><a href='https://rdrr.io/r/stats/Weibull.html'>pweibull</a></code> with additionall location parameter and scale=1) + hormesis with the default estimation method.</p></dd> + + <dt>probit</dt> +<dd><p>A boolean defining if cumulative density curves of normal distributions + <code><a href="https://rdrr.io/r/stats/Normal.html" class="external-link">pnorm</a></code> are fitted against the decadic logarithm of the dose. + Default ist TRUE.</p></dd> + + <dt>logit</dt> +<dd><p>A boolean defining if cumulative density curves of logistic distributions + <code><a href="https://rdrr.io/r/stats/Logistic.html" class="external-link">plogis</a></code> are fitted to the decadic logarithm of the dose. + Default is FALSE.</p></dd> + + <dt>weibull</dt> +<dd><p>A boolean defining if the cumulative density curves of weibull distributions + (<code><a href="https://rdrr.io/r/stats/Weibull.html" class="external-link">pweibull</a></code> with additionall location parameter and scale=1) are fitted to the decadic logarithm of the dose. Default is FALSE. Note that the weibull distribution is fitted here to the log transformed doses - which appears to be an uncommon approach.</p></td> - </tr> - <tr> - <th>linlogit</th> - <td><p>A boolean defining if the linear-logistic function - <code><a href='linlogitf.html'>linlogitf</a></code> as defined by van Ewijk and Hoekstra 1993 is - fitted to the data. Default is FALSE.</p></td> - </tr> - <tr> - <th>level</th> - <td><p>The level for the confidence interval listed for the log ED50.</p></td> - </tr> - <tr> - <th>linlogitWrong</th> - <td><p>An optional vector containing the names of the substances for which the - linlogit function produces a wrong fit.</p></td> - </tr> - <tr> - <th>allWrong</th> - <td><p>An optional vector containing the names of the substances for which all - functions produce a wrong fit.</p></td> - </tr> - <tr> - <th>chooseone</th> - <td><p>If TRUE (default), the models are tried in the order linlogit, probit, + which appears to be an uncommon approach.</p></dd> + + <dt>linlogit</dt> +<dd><p>A boolean defining if the linear-logistic function + <code><a href="linlogitf.html">linlogitf</a></code> as defined by van Ewijk and Hoekstra 1993 is + fitted to the data. Default is FALSE.</p></dd> + + <dt>level</dt> +<dd><p>The level for the confidence interval listed for the log ED50.</p></dd> + + <dt>linlogitWrong</dt> +<dd><p>An optional vector containing the names of the substances for which the + linlogit function produces a wrong fit.</p></dd> + + <dt>allWrong</dt> +<dd><p>An optional vector containing the names of the substances for which all + functions produce a wrong fit.</p></dd> + + <dt>chooseone</dt> +<dd><p>If TRUE (default), the models are tried in the order linlogit, probit, logit, weibull, and the first model that produces a valid fit is used. If FALSE, all models that are set to TRUE and that can be fitted will be - reported.</p></td> - </tr> - <tr> - <th>ps0</th> - <td><p>If the probit model is fitted, <code>ps0</code> gives the possibility to adjust - the starting value for the scale parameter of <code><a href='https://rdrr.io/r/stats/Normal.html'>pnorm</a></code>.</p></td> - </tr> - <tr> - <th>ls0</th> - <td><p>If the logit model is fitted, <code>ls0</code> gives the possibility to adjust - the starting value for the scale parameter of <code><a href='https://rdrr.io/r/stats/Logistic.html'>plogis</a></code>.</p></td> - </tr> - <tr> - <th>ws0</th> - <td><p>If the weibull model is fitted, <code>ws0</code> gives the possibility to adjust - the starting value for the shape parameter of <code><a href='https://rdrr.io/r/stats/Weibull.html'>pweibull</a></code>.</p></td> - </tr> - <tr> - <th>b0,f0</th> - <td><p>If the linearlogistic model is fitted, <code>b0</code> and <code>f0</code> give the - possibility to adjust the starting values for the parameters b and f.</p></td> - </tr> - <tr> - <th>showED50</th> - <td><p>If set to TRUE, the ED50 and its confidence interval on the original dose - scale (not log scale) is included in the output.</p></td> - </tr> - <tr> - <th>EDx</th> - <td><p>A vector of inhibition values x in percent for which the corresponding doses - EDx should be reported.</p></td> - </tr> - <tr> - <th>EDx.tolerance</th> - <td><p>Tolerance of the effect level, expressed on the response scale from 0 to 1.</p></td> - </tr> - </table> - - <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> - - <p>A dataframe with the attribute <code>models</code> holding a list of the fitted - dose-response models of class <code><a href='https://rdrr.io/r/stats/nls.html'>nls</a></code>. The dataframe has at least + reported.</p></dd> + + <dt>ps0</dt> +<dd><p>If the probit model is fitted, <code>ps0</code> gives the possibility to adjust + the starting value for the scale parameter of <code><a href="https://rdrr.io/r/stats/Normal.html" class="external-link">pnorm</a></code>.</p></dd> + + <dt>ls0</dt> +<dd><p>If the logit model is fitted, <code>ls0</code> gives the possibility to adjust + the starting value for the scale parameter of <code><a href="https://rdrr.io/r/stats/Logistic.html" class="external-link">plogis</a></code>.</p></dd> + + <dt>ws0</dt> +<dd><p>If the weibull model is fitted, <code>ws0</code> gives the possibility to adjust + the starting value for the shape parameter of <code><a href="https://rdrr.io/r/stats/Weibull.html" class="external-link">pweibull</a></code>.</p></dd> + + <dt>b0,f0</dt> +<dd><p>If the linearlogistic model is fitted, <code>b0</code> and <code>f0</code> give the + possibility to adjust the starting values for the parameters b and f.</p></dd> + + <dt>showED50</dt> +<dd><p>If set to TRUE, the ED50 and its confidence interval on the original dose + scale (not log scale) is included in the output.</p></dd> + + <dt>EDx</dt> +<dd><p>A vector of inhibition values x in percent for which the corresponding doses + EDx should be reported.</p></dd> + + <dt>EDx.tolerance</dt> +<dd><p>Tolerance of the effect level, expressed on the response scale from 0 to 1.</p></dd> + +</dl></div> + <div id="value"> + <h2>Value</h2> + + +<p>A dataframe with the attribute <code>models</code> holding a list of the fitted + dose-response models of class <code><a href="https://rdrr.io/r/stats/nls.html" class="external-link">nls</a></code>. The dataframe has at least one line for each substance.</p> -<p>For the “linlogit”, “logit” and “probit” models, the + + +<p>For the “linlogit”, “logit” and “probit” models, the parameter <code>a</code> that is reported coincides with the logED50, i.e the logED50 is one of the model parameters that is being fitted. Therefore, a confidence interval for the confidence level <code>level</code> is calculated using the <code>confint.nls</code> function and listed.</p> + + <p>The following variables are in the dataframe:</p> -<dt>Substance</dt><dd><p>The name of the substance</p></dd> - <dt>ndl</dt><dd><p>The number of dose levels in the raw data</p></dd> - <dt>n</dt><dd><p>The total number of data points in the raw data used for the fit</p></dd> - <dt>lld</dt><dd><p>The decadic logarithm of the lowest dose</p></dd> - <dt>lhd</dt><dd><p>The total number of data points in the raw data used for the fit</p></dd> - <dt>mtype</dt><dd><p>If the data did not show a mean response < 0.5 at the highest dose level, - the modeltype is set to “inactive”. If the mean response at the - lowest dose is smaller than 0.5, the modeltype is set to “active”. +<dl><dt>Substance</dt> +<dd><p>The name of the substance</p></dd> + + <dt>ndl</dt> +<dd><p>The number of dose levels in the raw data</p></dd> + + <dt>n</dt> +<dd><p>The total number of data points in the raw data used for the fit</p></dd> + + <dt>lld</dt> +<dd><p>The decadic logarithm of the lowest dose</p></dd> + + <dt>lhd</dt> +<dd><p>The total number of data points in the raw data used for the fit</p></dd> + + <dt>mtype</dt> +<dd><p>If the data did not show a mean response < 0.5 at the highest dose level, + the modeltype is set to “inactive”. If the mean response at the + lowest dose is smaller than 0.5, the modeltype is set to “active”. In both cases, no fitting procedure is carried out. If the fitted ED50 - is higher than the highest dose, “no fit” is given here.</p></dd> - <dt>logED50</dt><dd><p>The decadic logarithm of the ED50</p></dd> - <dt>low %</dt><dd><p>The lower bound of the confidence interval of log ED50. + is higher than the highest dose, “no fit” is given here.</p></dd> + + <dt>logED50</dt> +<dd><p>The decadic logarithm of the ED50</p></dd> + + <dt>low %</dt> +<dd><p>The lower bound of the confidence interval of log ED50. The name of the column depends on the requested confidence <code>level</code>.</p></dd> - <dt>high %</dt><dd><p>The higher bound of the confidence interval of log ED50. + + <dt>high %</dt> +<dd><p>The higher bound of the confidence interval of log ED50. The name of the column depends on the requested confidence <code>level</code>.</p></dd> - <dt>unit</dt><dd><p>The unit used for the dose levels in the dose-response data</p></dd> - <dt>sigma</dt><dd><p>The square root of the estimated variance of the random error as returned - by <code><a href='https://rdrr.io/r/stats/summary.nls.html'>summary.nls</a></code>.</p></dd> - <dt>a</dt><dd><p>For the “linlogit”, “logit” and “probit” models, the + + <dt>unit</dt> +<dd><p>The unit used for the dose levels in the dose-response data</p></dd> + + <dt>sigma</dt> +<dd><p>The square root of the estimated variance of the random error as returned + by <code><a href="https://rdrr.io/r/stats/summary.nls.html" class="external-link">summary.nls</a></code>.</p></dd> + + <dt>a</dt> +<dd><p>For the “linlogit”, “logit” and “probit” models, the parameter <code>a</code> coincides with the logED50. In the case of the - “weibull” model, <code>a</code> is a location parameter.</p></dd> - <dt>b</dt><dd><p>Parameter <code>b</code> in the case of the “linlogit” fit is the variable - b from the <code><a href='linlogitf.html'>linlogitf</a></code> function. In the case of “probit” + “weibull” model, <code>a</code> is a location parameter.</p></dd> + + <dt>b</dt> +<dd><p>Parameter <code>b</code> in the case of the “linlogit” fit is the variable + b from the <code><a href="linlogitf.html">linlogitf</a></code> function. In the case of “probit” fit it is the standard deviation of the fitted normal distribution, in the - case of the “logit” fit it is the <code>scale</code> parameter in the - <code><a href='https://rdrr.io/r/stats/Logistic.html'>plogis</a></code> function, and in the “weibull” fit it is the - <code>shape</code> parameter of the fitted <code><a href='https://rdrr.io/r/stats/Weibull.html'>pweibull</a></code> function.</p></dd> - <dt>c</dt><dd><p>Only the “linlogit” fit produces a third parameter <code>c</code> which is - the variable f from the <code><a href='linlogitf.html'>linlogitf</a></code> function.</p></dd> - If the parameter showED50 was set to TRUE, the ED50 values and their - confidence intervals are also included on the original dose scale. + case of the “logit” fit it is the <code>scale</code> parameter in the + <code><a href="https://rdrr.io/r/stats/Logistic.html" class="external-link">plogis</a></code> function, and in the “weibull” fit it is the + <code>shape</code> parameter of the fitted <code><a href="https://rdrr.io/r/stats/Weibull.html" class="external-link">pweibull</a></code> function.</p></dd> - If one or more response leves were specified in the argument EDx, - the corresponding dose levels are given in addition. + <dt>c</dt> +<dd><p>Only the “linlogit” fit produces a third parameter <code>c</code> which is + the variable f from the <code><a href="linlogitf.html">linlogitf</a></code> function.</p></dd> - <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2> +</dl><p>If the parameter <code>showED50</code> was set to TRUE, the ED50 values and their + confidence intervals are also included on the original dose scale.</p> - <p>There is a demo for each dataset that can be accessed by - <code><a href='https://rdrr.io/r/utils/demo.html'>demo(dataset)</a></code></p> - <h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2> - <div class='dont-index'><p>Further examples are given in help pages to the datasets - <code><a href='antifoul.html'>antifoul</a></code>, <code><a href='IM1xIPC81.html'>IM1xIPC81</a></code> and - <code><a href='IM1xVibrio.html'>IM1xVibrio</a></code>. +<p>If one or more response leves were specified in the argument <code>EDx</code>, + the corresponding dose levels are given in addition.</p> + </div> + <div id="note"> + <h2>Note</h2> + <p>There is a demo for each dataset that can be accessed by + <code>demo(dataset)</code></p> + </div> + <div id="see-also"> + <h2>See also</h2> + <div class="dont-index"><p>Further examples are given in help pages to the datasets + <code><a href="antifoul.html">antifoul</a></code>, <code><a href="IM1xIPC81.html">IM1xIPC81</a></code> and + <code><a href="IM1xVibrio.html">IM1xVibrio</a></code>. Since version 0.6.1 of this package, there is a drop-in replacement function - <code><a href='drcfit.html'>drcfit</a></code> which internally uses the drc package and also gives + <code><a href="drcfit.html">drcfit</a></code> which internally uses the drc package and also gives confidence intervals for EDx values via this package.</p></div> - - <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> - <pre class="examples"><div class='input'><span class='fu'><a href='https://rdrr.io/r/utils/data.html'>data</a></span>(<span class='no'>antifoul</span>) -<span class='no'>r</span> <span class='kw'><-</span> <span class='fu'>drfit</span>(<span class='no'>antifoul</span>, <span class='kw'>showED50</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>EDx</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>5</span>, <span class='fl'>10</span>, <span class='fl'>20</span>))</div><div class='output co'>#> <span class='message'></span> -#> <span class='message'>TBT: Fitting data...</span></div><div class='output co'>#> <span class='message'>Waiting for profiling to be done...</span></div><div class='output co'>#> <span class='message'></span> -#> <span class='message'>Zn Pyrithion: Fitting data...</span></div><div class='output co'>#> <span class='message'>Waiting for profiling to be done...</span></div><div class='input'><span class='fu'><a href='https://rdrr.io/r/base/format.html'>format</a></span>(<span class='no'>r</span>, <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>2</span>)</div><div class='output co'>#> Substance ndl n lld lhd mtype logED50 2.5% 97.5% unit sigma a -#> 1 TBT 38 135 -2.7 2.4 probit -0.16 -0.27 -0.056 microM 0.19 -0.16 -#> 2 Zn Pyrithion 27 81 -2.1 2.0 probit -0.40 -0.51 -0.292 microM 0.23 -0.40 -#> b ED50 ED50 2.5% ED50 97.5% EDx5 EDx10 EDx20 -#> 1 0.68 0.68 0.54 0.88 0.053 0.093 0.18 -#> 2 0.42 0.40 0.31 0.51 0.082 0.117 0.18</div></pre> - </div> - <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> - <h2>Contents</h2> - <ul class="nav nav-pills nav-stacked"> - <li><a href="#arguments">Arguments</a></li> - <li><a href="#value">Value</a></li> - <li><a href="#note">Note</a></li> - <li><a href="#see-also">See also</a></li> - <li><a href="#examples">Examples</a></li> - </ul> - + </div> + <div id="author"> <h2>Author</h2> <p>Johannes Ranke - <a href='mailto:jranke@uni-bremen.de'>jranke@uni-bremen.de</a></p> + <a href="mailto:jranke@uni-bremen.de">jranke@uni-bremen.de</a></p> + </div> + + <div id="ref-examples"> + <h2>Examples</h2> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/utils/data.html" class="external-link">data</a></span><span class="op">(</span><span class="va">antifoul</span><span class="op">)</span></span></span> +<span class="r-in"><span><span class="va">r</span> <span class="op"><-</span> <span class="fu">drfit</span><span class="op">(</span><span class="va">antifoul</span>, showED50 <span class="op">=</span> <span class="cn">TRUE</span>, EDx <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">5</span>, <span class="fl">10</span>, <span class="fl">20</span><span class="op">)</span><span class="op">)</span></span></span> +<span class="r-msg co"><span class="r-pr">#></span> </span> +<span class="r-msg co"><span class="r-pr">#></span> TBT: Fitting data...</span> +<span class="r-msg co"><span class="r-pr">#></span> Waiting for profiling to be done...</span> +<span class="r-msg co"><span class="r-pr">#></span> </span> +<span class="r-msg co"><span class="r-pr">#></span> Zn Pyrithion: Fitting data...</span> +<span class="r-msg co"><span class="r-pr">#></span> Waiting for profiling to be done...</span> +<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/format.html" class="external-link">format</a></span><span class="op">(</span><span class="va">r</span>, digits <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span></span> +<span class="r-out co"><span class="r-pr">#></span> Substance ndl n lld lhd mtype logED50 2.5% 97.5% unit sigma a</span> +<span class="r-out co"><span class="r-pr">#></span> 1 TBT 38 135 -2.7 2.4 probit -0.16 -0.27 -0.056 microM 0.19 -0.16</span> +<span class="r-out co"><span class="r-pr">#></span> 2 Zn Pyrithion 27 81 -2.1 2.0 probit -0.40 -0.51 -0.292 microM 0.23 -0.40</span> +<span class="r-out co"><span class="r-pr">#></span> b ED50 ED50 2.5% ED50 97.5% EDx5 EDx10 EDx20</span> +<span class="r-out co"><span class="r-pr">#></span> 1 0.68 0.68 0.54 0.88 0.053 0.093 0.18</span> +<span class="r-out co"><span class="r-pr">#></span> 2 0.42 0.40 0.31 0.51 0.082 0.117 0.18</span> +</code></pre></div> + </div> </div> + <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> + <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2> + </nav></div> </div> - <footer> - <div class="copyright"> - <p>Developed by Johannes Ranke.</p> + <footer><div class="copyright"> + <p></p><p>Developed by Johannes Ranke.</p> </div> <div class="pkgdown"> - <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p> </div> - </footer> - </div> + </footer></div> - </body> -</html> + + </body></html> |