From 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 25 Oct 2019 00:37:42 +0200 Subject: Use roxygen for functions and methods --- man/logistic.solution.Rd | 52 +++++++++++++++++++++++++++--------------------- 1 file changed, 29 insertions(+), 23 deletions(-) (limited to 'man/logistic.solution.Rd') diff --git a/man/logistic.solution.Rd b/man/logistic.solution.Rd index 05b6c0aa..def776aa 100644 --- a/man/logistic.solution.Rd +++ b/man/logistic.solution.Rd @@ -1,36 +1,35 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/logistic.solution.R \name{logistic.solution} \alias{logistic.solution} -\title{ Logistic kinetics } -\description{ - Function describing exponential decline from a defined starting value, with - an increasing rate constant, supposedly caused by microbial growth -} +\title{Logistic kinetics} \usage{ logistic.solution(t, parent.0, kmax, k0, r) } \arguments{ - \item{t}{ Time. } - \item{parent.0}{ Starting value for the response variable at time zero. } - \item{kmax}{ Maximum rate constant. } - \item{k0}{ Minumum rate constant effective at time zero. } - \item{r}{ Growth rate of the increase in the rate constant. } -} -\note{ - The solution of the logistic model reduces to the - \code{\link{SFO.solution}} if \code{k0} is equal to - \code{kmax}. +\item{t}{Time.} + +\item{parent.0}{Starting value for the response variable at time zero.} + +\item{kmax}{Maximum rate constant.} + +\item{k0}{Minumum rate constant effective at time zero.} + +\item{r}{Growth rate of the increase in the rate constant.} } \value{ - The value of the response variable at time \code{t}. +The value of the response variable at time \code{t}. } -\references{ - FOCUS (2014) \dQuote{Generic guidance for Estimating Persistence and - Degradation Kinetics from Environmental Fate Studies on Pesticides in EU - Registration} Report of the FOCUS Work Group on Degradation Kinetics, - Version 1.1, 18 December 2014 - \url{http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics} +\description{ +Function describing exponential decline from a defined starting value, with +an increasing rate constant, supposedly caused by microbial growth +} +\note{ +The solution of the logistic model reduces to the + \code{\link{SFO.solution}} if \code{k0} is equal to \code{kmax}. } \examples{ + # Reproduce the plot on page 57 of FOCUS (2014) plot(function(x) logistic.solution(x, 100, 0.08, 0.0001, 0.2), from = 0, to = 100, ylim = c(0, 100), @@ -64,5 +63,12 @@ logistic.solution(t, parent.0, kmax, k0, r) plot_sep(m) summary(m)$bpar endpoints(m)$distimes + +} +\references{ +FOCUS (2014) \dQuote{Generic guidance for Estimating Persistence + and Degradation Kinetics from Environmental Fate Studies on Pesticides in + EU Registration} Report of the FOCUS Work Group on Degradation Kinetics, + Version 1.1, 18 December 2014 + \url{http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics} } -\keyword{ manip } -- cgit v1.2.1