diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2020-05-12 08:07:07 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2020-05-12 08:36:31 +0200 |
| commit | 9ac853c7ceece333099021974025d07e75be2b33 (patch) | |
| tree | 21bd165193456a616140eb5b2484a1bb75dab765 /R | |
| parent | feca0008dcf662bba5c728096c4e63b923b8979b (diff) | |
Documentation improvements, rebuild static docs
Diffstat (limited to 'R')
| -rw-r--r-- | R/mkinfit.R | 10 | ||||
| -rw-r--r-- | R/mkinmod.R | 7 |
2 files changed, 13 insertions, 4 deletions
diff --git a/R/mkinfit.R b/R/mkinfit.R index 683a6b3d..c796f06f 100644 --- a/R/mkinfit.R +++ b/R/mkinfit.R @@ -165,8 +165,12 @@ if(getRversion() >= '2.15.1') utils::globalVariables(c("name", "time", "value")) #' #' Fitting of several models to several datasets in a single call to #' \code{\link{mmkin}}. -#' @source Rocke, David M. und Lorenzato, Stefan (1995) A two-component model -#' for measurement error in analytical chemistry. Technometrics 37(2), 176-184. +#' @references Rocke DM and Lorenzato S (1995) A two-component model +#' for measurement error in analytical chemistry. *Technometrics* 37(2), 176-184. +#' +#' Ranke J and Meinecke S (2019) Error Models for the Kinetic Evaluation of Chemical +#' Degradation Data. *Environments* 6(12) 124 +#' [doi:10.3390/environments6120124](https://doi.org/10.3390/environments6120124). #' @examples #' #' # Use shorthand notation for parent only degradation @@ -217,7 +221,7 @@ if(getRversion() >= '2.15.1') utils::globalVariables(c("name", "time", "value")) #' } #' #' \dontrun{ -#' # Weighted fits, including IRLS +#' # Weighted fits, including IRLS (error_model = "obs") #' SFO_SFO.ff <- mkinmod(parent = mkinsub("SFO", "m1"), #' m1 = mkinsub("SFO"), use_of_ff = "max") #' f.noweight <- mkinfit(SFO_SFO.ff, FOCUS_2006_D, quiet = TRUE) diff --git a/R/mkinmod.R b/R/mkinmod.R index 7e9e9248..e58d1e22 100644 --- a/R/mkinmod.R +++ b/R/mkinmod.R @@ -48,12 +48,17 @@ #' \item{use_of_ff}{ #' The content of \code{use_of_ff} is passed on in this list component. #' } +#' \item{deg_func}{ +#' If generated, a function containing the solution of the degradation +#' model. +#' } #' \item{coefmat}{ #' The coefficient matrix, if the system of differential equations can be #' represented by one. #' } #' \item{cf}{ -#' If generated, the compiled function as returned by cfunction. +#' If generated, a compiled function calculating the derivatives as +#' returned by cfunction. #' } #' @note The IORE submodel is not well tested for metabolites. When using this #' model for metabolites, you may want to read the second note in the help |