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 --- docs/reference/add_err.html | 4 +- docs/reference/endpoints.html | 6 +- docs/reference/index.html | 2 +- docs/reference/logistic.solution.html | 4 +- docs/reference/mccall81_245T.html | 113 ++++++++++++++------------------- docs/reference/mkinfit.html | 42 ++++++------ docs/reference/mkinpredict.html | 14 ++-- docs/reference/transform_odeparms.html | 6 +- 8 files changed, 88 insertions(+), 103 deletions(-) (limited to 'docs/reference') diff --git a/docs/reference/add_err.html b/docs/reference/add_err.html index c25bbe17..7c420146 100644 --- a/docs/reference/add_err.html +++ b/docs/reference/add_err.html @@ -74,7 +74,7 @@ may depend on the predicted value and is specified as a standard deviation." /> mkin - 0.9.50.1 + 0.9.50.2 @@ -211,7 +211,7 @@ components of the list are datasets compatible with 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

diff --git a/docs/reference/endpoints.html b/docs/reference/endpoints.html index 05d65191..d9c43f84 100644 --- a/docs/reference/endpoints.html +++ b/docs/reference/endpoints.html @@ -45,7 +45,7 @@ with mkinfit — endpoints" /> @@ -78,7 +78,7 @@ advantage that the SFORB model can also be used for metabolites." /> mkin - 0.9.50.1 + 0.9.50.2
@@ -151,7 +151,7 @@ with mkinfit

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.

diff --git a/docs/reference/index.html b/docs/reference/index.html index ed6debdd..961352e0 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -71,7 +71,7 @@ mkin - 0.9.50.1 + 0.9.50.2 diff --git a/docs/reference/logistic.solution.html b/docs/reference/logistic.solution.html index 9907297c..4820d25f 100644 --- a/docs/reference/logistic.solution.html +++ b/docs/reference/logistic.solution.html @@ -73,7 +73,7 @@ an increasing rate constant, supposedly caused by microbial growth" /> mkin - 0.9.50.1 + 0.9.50.2 @@ -165,7 +165,7 @@ an increasing rate constant, supposedly caused by microbial growth

k0 -

Minumum rate constant effective at time zero.

+

Minimum rate constant effective at time zero.

r diff --git a/docs/reference/mccall81_245T.html b/docs/reference/mccall81_245T.html index ce2d40cd..06fcd79e 100644 --- a/docs/reference/mccall81_245T.html +++ b/docs/reference/mccall81_245T.html @@ -10,23 +10,27 @@ - + - + - + + + + + - - + + - + - - + + @@ -39,7 +43,6 @@ - @@ -57,7 +60,7 @@ - +
@@ -115,7 +118,12 @@
@@ -145,7 +153,7 @@

Format

-

A dataframe containing the following variables.

+

A dataframe containing the following variables.

name

the name of the compound observed. Note that T245 is used as an acronym for 2,4,5-T. T245 is a legitimate object name in R, which is necessary for specifying models using @@ -159,34 +167,31 @@

Source

-

McCall P, Vrona SA, Kelley SS (1981) Fate of uniformly carbon-14 ring labeled 2,4,5-Trichlorophenoxyacetic acid and 2,4-dichlorophenoxyacetic acid. J Agric Chem 29, 100-107 +

McCall P, Vrona SA, Kelley SS (1981) Fate of uniformly carbon-14 ring labelled 2,4,5-Trichlorophenoxyacetic acid and 2,4-dichlorophenoxyacetic acid. J Agric Chem 29, 100-107 http://dx.doi.org/10.1021/jf00103a026

Examples

SFO_SFO_SFO <- mkinmod(T245 = list(type = "SFO", to = "phenol"), phenol = list(type = "SFO", to = "anisole"), anisole = list(type = "SFO"))
#> Successfully compiled differential equation model from auto-generated C code.
# \dontrun{ - fit.1 <- mkinfit(SFO_SFO_SFO, subset(mccall81_245T, soil == "Commerce"), quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(fit.1)$bpar
#> Warning: NaNs wurden erzeugt
#> Estimate se_notrans t value Pr(>t) Lower -#> T245_0 1.038550e+02 2.1508110557 48.286452 3.542232e-18 99.246062215 -#> k_T245_sink 1.636106e-02 NaN NaN NaN 0.012661558 -#> k_T245_phenol 2.700936e-02 NaN NaN NaN 0.024487315 -#> k_phenol_sink 1.788604e-10 NaN NaN NaN 0.000000000 -#> k_phenol_anisole 4.050581e-01 0.1053801116 3.843781 7.970202e-04 0.218013982 -#> k_anisole_sink 6.678742e-03 0.0006205844 10.762020 9.428076e-09 0.005370739 -#> sigma 2.514628e+00 0.3383670685 7.431657 1.054101e-06 1.706607296 -#> Upper -#> T245_0 1.084640e+02 -#> k_T245_sink 2.114150e-02 -#> k_T245_phenol 2.979116e-02 -#> k_phenol_sink Inf -#> k_phenol_anisole 7.525759e-01 -#> k_anisole_sink 8.305299e-03 -#> sigma 3.322649e+00
endpoints(fit.1)
#> $ff -#> T245_sink T245_phenol phenol_sink phenol_anisole anisole_sink -#> 3.772401e-01 6.227599e-01 4.415672e-10 1.000000e+00 1.000000e+00 -#> -#> $SFORB -#> logical(0) + fit.1 <- mkinfit(SFO_SFO_SFO, subset(mccall81_245T, soil == "Commerce"), quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(fit.1)$bpar
#> Estimate se_notrans t value Pr(>t) +#> T245_0 1.038550e+02 2.184707514 47.537272 4.472189e-18 +#> k_T245 4.337042e-02 0.001898397 22.845818 2.276912e-13 +#> k_phenol 4.050581e-01 0.298699428 1.356073 9.756994e-02 +#> k_anisole 6.678742e-03 0.000802144 8.326114 2.623179e-07 +#> f_T245_to_phenol 6.227599e-01 0.398534167 1.562626 6.949418e-02 +#> f_phenol_to_anisole 1.000000e+00 0.671844168 1.488440 7.867794e-02 +#> sigma 2.514628e+00 0.490755943 5.123989 6.233164e-05 +#> Lower Upper +#> T245_0 99.246061371 1.084640e+02 +#> k_T245 0.039631621 4.746194e-02 +#> k_phenol 0.218013878 7.525762e-01 +#> k_anisole 0.005370739 8.305299e-03 +#> f_T245_to_phenol 0.547559082 6.924813e-01 +#> f_phenol_to_anisole 0.000000000 1.000000e+00 +#> sigma 1.706607296 3.322649e+00
endpoints(fit.1)
#> $ff +#> T245_phenol T245_sink phenol_anisole phenol_sink +#> 6.227599e-01 3.772401e-01 1.000000e+00 1.748047e-10 #> #> $distimes #> DT50 DT90 @@ -196,42 +201,22 @@ #>
# k_phenol_sink is really small, therefore fix it to zero fit.2 <- mkinfit(SFO_SFO_SFO, subset(mccall81_245T, soil == "Commerce"), parms.ini = c(k_phenol_sink = 0), - fixed_parms = "k_phenol_sink", quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(fit.2)$bpar
#> Estimate se_notrans t value Pr(>t) Lower -#> T245_0 1.038550e+02 2.1623653063 48.028441 4.993105e-19 99.271025146 -#> k_T245_sink 1.636106e-02 0.0019676255 8.315130 1.673674e-07 0.012679148 -#> k_T245_phenol 2.700936e-02 0.0012421966 21.743224 1.314080e-13 0.024500319 -#> k_phenol_anisole 4.050581e-01 0.1177235488 3.440757 1.679237e-03 0.218746679 -#> k_anisole_sink 6.678742e-03 0.0006829745 9.778904 1.872892e-08 0.005377084 -#> sigma 2.514628e+00 0.3790944250 6.633250 2.875782e-06 1.710983655 -#> Upper -#> T245_0 108.43904395 -#> k_T245_sink 0.02111217 -#> k_T245_phenol 0.02977535 -#> k_phenol_anisole 0.75005504 -#> k_anisole_sink 0.00829550 -#> sigma 3.31827222
endpoints(fit.1)
#> $ff -#> T245_sink T245_phenol phenol_sink phenol_anisole anisole_sink -#> 3.772401e-01 6.227599e-01 4.415672e-10 1.000000e+00 1.000000e+00 -#> -#> $SFORB -#> logical(0) + fixed_parms = "k_phenol_sink", quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
#> Warning: Initial parameter(s) k_phenol_sink not used in the model
#> Error in data.frame(value = c(state.ini.fixed, parms.fixed)): Zeilennamen enthalten fehlende Werte
summary(fit.2)$bpar
#> Error in summary(fit.2): Objekt 'fit.2' nicht gefunden
endpoints(fit.1)
#> $ff +#> T245_phenol T245_sink phenol_anisole phenol_sink +#> 6.227599e-01 3.772401e-01 1.000000e+00 1.748047e-10 #> #> $distimes #> DT50 DT90 #> T245 15.982025 53.09114 #> phenol 1.711229 5.68458 #> anisole 103.784092 344.76329 -#>
plot_sep(fit.2)
# } +#>
plot_sep(fit.2)
#> Error in identical(fit$err_mod, "const"): Objekt 'fit.2' nicht gefunden
# }
- @@ -242,7 +227,7 @@
-

Site built with pkgdown 1.4.1.

+

Site built with pkgdown 1.5.1.

diff --git a/docs/reference/mkinfit.html b/docs/reference/mkinfit.html index ceac59bf..5d8dd81c 100644 --- a/docs/reference/mkinfit.html +++ b/docs/reference/mkinfit.html @@ -42,7 +42,7 @@ mkin - 0.9.50.1 + 0.9.50.2 @@ -149,7 +149,7 @@ likelihood function." />

This function maximises the likelihood of the observed data using the Port algorithm 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 mkinpredict. The parameters of the selected error model are fitted simultaneously with the degradation model parameters, as both of them are arguments of the @@ -420,17 +420,17 @@ Degradation Data. Environments 6(12) 124

# Use shorthand notation for parent only degradation fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE) -summary(fit)
#> mkin version used for fitting: 0.9.50.1 +summary(fit)
#> mkin version used for fitting: 0.9.50.2 #> R version used for fitting: 4.0.0 -#> Date of fit: Tue May 12 08:36:07 2020 -#> Date of summary: Tue May 12 08:36:07 2020 +#> Date of fit: Tue May 12 10:55:39 2020 +#> Date of summary: Tue May 12 10:55:39 2020 #> #> Equations: #> d_parent/dt = - (alpha/beta) * 1/((time/beta) + 1) * parent #> #> Model predictions using solution type analytical #> -#> Fitted using 222 model solutions performed in 0.047 s +#> Fitted using 222 model solutions performed in 0.043 s #> #> Error model: Constant variance #> @@ -507,7 +507,7 @@ Degradation Data. Environments 6(12) 124 m1 = mkinsub("SFO"))
#> Successfully compiled differential equation model from auto-generated C code.
# Fit the model to the FOCUS example dataset D using defaults print(system.time(fit <- mkinfit(SFO_SFO, FOCUS_2006_D, solution_type = "eigen", quiet = TRUE)))
#> Warning: Observations with value of zero were removed from the data
#> User System verstrichen -#> 0.408 0.008 0.416
parms(fit)
#> parent_0 k_parent k_m1 f_parent_to_m1 sigma +#> 0.408 0.001 0.410
parms(fit)
#> parent_0 k_parent k_m1 f_parent_to_m1 sigma #> 99.598483222 0.098697734 0.005260651 0.514475962 3.125503875
#> $ff #> parent_m1 parent_sink #> 0.514476 0.485524 @@ -597,7 +597,7 @@ Degradation Data. Environments 6(12) 124 #> Sum of squared residuals at call 166: 371.2134 #> Sum of squared residuals at call 168: 371.2134 #> Negative log-likelihood at call 178: 97.22429
#> Optimisation successfully terminated.
#> User System verstrichen -#> 0.350 0.001 0.351
parms(fit.deSolve)
#> parent_0 k_parent k_m1 f_parent_to_m1 sigma +#> 0.353 0.000 0.352
parms(fit.deSolve)
#> parent_0 k_parent k_m1 f_parent_to_m1 sigma #> 99.598480759 0.098697739 0.005260651 0.514475958 3.125503874
endpoints(fit.deSolve)
#> $ff #> parent_m1 parent_sink #> 0.514476 0.485524 @@ -629,10 +629,10 @@ Degradation Data. Environments 6(12) 124 # \dontrun{ # Weighted fits, including IRLS (error_model = "obs") SFO_SFO.ff <- mkinmod(parent = mkinsub("SFO", "m1"), - m1 = mkinsub("SFO"), use_of_ff = "max")
#> Successfully compiled differential equation model from auto-generated C code.
f.noweight <- mkinfit(SFO_SFO.ff, FOCUS_2006_D, quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(f.noweight)
#> mkin version used for fitting: 0.9.50.1 + m1 = mkinsub("SFO"), use_of_ff = "max")
#> Successfully compiled differential equation model from auto-generated C code.
f.noweight <- mkinfit(SFO_SFO.ff, FOCUS_2006_D, quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(f.noweight)
#> mkin version used for fitting: 0.9.50.2 #> R version used for fitting: 4.0.0 -#> Date of fit: Tue May 12 08:36:12 2020 -#> Date of summary: Tue May 12 08:36:12 2020 +#> Date of fit: Tue May 12 10:55:44 2020 +#> Date of summary: Tue May 12 10:55:44 2020 #> #> Equations: #> d_parent/dt = - k_parent * parent @@ -640,7 +640,7 @@ Degradation Data. Environments 6(12) 124 #> #> Model predictions using solution type analytical #> -#> Fitted using 421 model solutions performed in 0.146 s +#> Fitted using 421 model solutions performed in 0.147 s #> #> Error model: Constant variance #> @@ -751,10 +751,10 @@ Degradation Data. Environments 6(12) 124 #> 100 m1 31.04 31.98163 -9.416e-01 #> 100 m1 33.13 31.98163 1.148e+00 #> 120 m1 25.15 28.78984 -3.640e+00 -#> 120 m1 33.31 28.78984 4.520e+00
f.obs <- mkinfit(SFO_SFO.ff, FOCUS_2006_D, error_model = "obs", quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(f.obs)
#> mkin version used for fitting: 0.9.50.1 +#> 120 m1 33.31 28.78984 4.520e+00
f.obs <- mkinfit(SFO_SFO.ff, FOCUS_2006_D, error_model = "obs", quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(f.obs)
#> mkin version used for fitting: 0.9.50.2 #> R version used for fitting: 4.0.0 -#> Date of fit: Tue May 12 08:36:13 2020 -#> Date of summary: Tue May 12 08:36:13 2020 +#> Date of fit: Tue May 12 10:55:44 2020 +#> Date of summary: Tue May 12 10:55:44 2020 #> #> Equations: #> d_parent/dt = - k_parent * parent @@ -762,7 +762,7 @@ Degradation Data. Environments 6(12) 124 #> #> Model predictions using solution type analytical #> -#> Fitted using 978 model solutions performed in 0.337 s +#> Fitted using 978 model solutions performed in 0.334 s #> #> Error model: Variance unique to each observed variable #> @@ -888,10 +888,10 @@ Degradation Data. Environments 6(12) 124 #> 100 m1 31.04 31.98773 -9.477e-01 #> 100 m1 33.13 31.98773 1.142e+00 #> 120 m1 25.15 28.80429 -3.654e+00 -#> 120 m1 33.31 28.80429 4.506e+00
f.tc <- mkinfit(SFO_SFO.ff, FOCUS_2006_D, error_model = "tc", quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(f.tc)
#> mkin version used for fitting: 0.9.50.1 +#> 120 m1 33.31 28.80429 4.506e+00
f.tc <- mkinfit(SFO_SFO.ff, FOCUS_2006_D, error_model = "tc", quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
summary(f.tc)
#> mkin version used for fitting: 0.9.50.2 #> R version used for fitting: 4.0.0 -#> Date of fit: Tue May 12 08:36:14 2020 -#> Date of summary: Tue May 12 08:36:14 2020 +#> Date of fit: Tue May 12 10:55:45 2020 +#> Date of summary: Tue May 12 10:55:45 2020 #> #> Equations: #> d_parent/dt = - k_parent * parent @@ -899,7 +899,7 @@ Degradation Data. Environments 6(12) 124 #> #> Model predictions using solution type analytical #> -#> Fitted using 1875 model solutions performed in 0.647 s +#> Fitted using 1875 model solutions performed in 0.643 s #> #> Error model: Two-component variance function #> diff --git a/docs/reference/mkinpredict.html b/docs/reference/mkinpredict.html index e48a0cdb..3035e03e 100644 --- a/docs/reference/mkinpredict.html +++ b/docs/reference/mkinpredict.html @@ -74,7 +74,7 @@ kinetic parameters and initial values for the state variables." /> mkin - 0.9.50 + 0.9.50.2
@@ -209,7 +209,7 @@ differential equations.

odeini -

A numeric vectory containing the initial values of the state +

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.

@@ -396,11 +396,11 @@ solver is used.

c(k_parent = 0.15, f_parent_to_m1 = 0.5, k_m1 = 0.01), c(parent = 100, m1 = 0), seq(0, 20, by = 0.1), solution_type = "analytical", use_compiled = FALSE)[201,]) -}
#> test relative elapsed -#> 4 analytical 1.00 0.004 -#> 2 deSolve_compiled 1.25 0.005 -#> 1 eigen 5.00 0.020 -#> 3 deSolve 54.25 0.217
+}
#> Lade nötiges Paket: rbenchmark
#> test relative elapsed +#> 4 analytical 1.0 0.005 +#> 2 deSolve_compiled 1.2 0.006 +#> 1 eigen 4.0 0.020 +#> 3 deSolve 43.8 0.219
# \dontrun{ # Predict from a fitted model f <- mkinfit(SFO_SFO, FOCUS_2006_C, quiet = TRUE) diff --git a/docs/reference/transform_odeparms.html b/docs/reference/transform_odeparms.html index fc0ffef2..185a8a64 100644 --- a/docs/reference/transform_odeparms.html +++ b/docs/reference/transform_odeparms.html @@ -42,7 +42,7 @@ @@ -77,7 +77,7 @@ the ilr transformation is used." /> mkin - 0.9.50.1 + 0.9.50.2
@@ -148,7 +148,7 @@ the ilr transformation is used." />

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 ilr transformation is used.

-- cgit v1.2.1