From 01284e456dc6df8e064a7a42f194fcd81d9ce7a1 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Tue, 12 May 2020 10:58:25 +0200 Subject: Improve documentation, now using a spell checker --- R/add_err.R | 2 +- R/endpoints.R | 2 +- R/mkinfit.R | 2 +- R/mkinpredict.R | 2 +- R/parent_solutions.R | 2 +- R/transform_odeparms.R | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) (limited to 'R') diff --git a/R/add_err.R b/R/add_err.R index 9235223f..d2092a84 100644 --- a/R/add_err.R +++ b/R/add_err.R @@ -25,7 +25,7 @@ #' @references Ranke J and Lehmann R (2015) To t-test or not to t-test, that is #' the question. XV Symposium on Pesticide Chemistry 2-4 September 2015, #' Piacenza, Italy -#' http://chem.uft.uni-bremen.de/ranke/posters/piacenza_2015.pdf +#' https://jrwb.de/posters/piacenza_2015.pdf #' @examples #' #' # The kinetic model diff --git a/R/endpoints.R b/R/endpoints.R index 586ef9ff..cccd2ff7 100644 --- a/R/endpoints.R +++ b/R/endpoints.R @@ -4,7 +4,7 @@ #' 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 +#' are equivalent to the rate constants of the DFOP model, but with the #' advantage that the SFORB model can also be used for metabolites. #' #' @param fit An object of class \code{\link{mkinfit}} or diff --git a/R/mkinfit.R b/R/mkinfit.R index c796f06f..0f478910 100644 --- a/R/mkinfit.R +++ b/R/mkinfit.R @@ -4,7 +4,7 @@ if(getRversion() >= '2.15.1') utils::globalVariables(c("name", "time", "value")) #' #' This function maximises the likelihood of the observed data using the Port #' algorithm \code{\link{nlminb}}, and the specified initial or fixed -#' parameters and starting values. In each step of the optimsation, the +#' parameters and starting values. In each step of the optimisation, the #' kinetic model is solved using the function \code{\link{mkinpredict}}. The #' parameters of the selected error model are fitted simultaneously with the #' degradation model parameters, as both of them are arguments of the diff --git a/R/mkinpredict.R b/R/mkinpredict.R index 90cd45fb..938d3488 100644 --- a/R/mkinpredict.R +++ b/R/mkinpredict.R @@ -11,7 +11,7 @@ #' @param odeparms A numeric vector specifying the parameters used in the #' kinetic model, which is generally defined as a set of ordinary #' differential equations. -#' @param odeini A numeric vectory containing the initial values of the state +#' @param odeini A numeric vector containing the initial values of the state #' variables of the model. Note that the state variables can differ from the #' observed variables, for example in the case of the SFORB model. #' @param outtimes A numeric vector specifying the time points for which model diff --git a/R/parent_solutions.R b/R/parent_solutions.R index e02bcda7..04226b73 100644 --- a/R/parent_solutions.R +++ b/R/parent_solutions.R @@ -191,7 +191,7 @@ SFORB.solution = function(t, parent_0, k_12, k_21, k_1output) { #' @family parent solutions #' @inherit SFO.solution #' @param kmax Maximum rate constant. -#' @param k0 Minumum rate constant effective at time zero. +#' @param k0 Minimum rate constant effective at time zero. #' @param 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}. diff --git a/R/transform_odeparms.R b/R/transform_odeparms.R index 28e58f87..8f6eb57f 100644 --- a/R/transform_odeparms.R +++ b/R/transform_odeparms.R @@ -2,7 +2,7 @@ #' #' The transformations are intended to map parameters that should only take on #' restricted values to the full scale of real numbers. For kinetic rate -#' constants and other paramters that can only take on positive values, a +#' constants and other parameters that can only take on positive values, a #' simple log transformation is used. For compositional parameters, such as the #' formations fractions that should always sum up to 1 and can not be negative, #' the \code{\link{ilr}} transformation is used. -- cgit v1.2.1