From e5d1df9a9b1f0951d7dfbaf24eee4294470b73e2 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 17 Nov 2022 14:54:20 +0100 Subject: Complete update of online docs for v1.2.0 --- docs/reference/nafta.html | 47 +++++++++++++++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 14 deletions(-) (limited to 'docs/reference/nafta.html') diff --git a/docs/reference/nafta.html b/docs/reference/nafta.html index 1d22b617..5906db4c 100644 --- a/docs/reference/nafta.html +++ b/docs/reference/nafta.html @@ -21,7 +21,7 @@ order of increasing model complexity, i.e. SFO, then IORE, and finally DFOP."> mkin - 1.1.0 + 1.2.0 @@ -48,11 +48,14 @@ order of increasing model complexity, i.e. SFO, then IORE, and finally DFOP.">Example evaluations of dimethenamid data from 2018 with nonlinear mixed-effects models
  • - Example evaluation of FOCUS Example Dataset Z + Short demo of the multistart method
  • Performance benefit by using compiled model definitions in mkin
    • +
  • + Example evaluation of FOCUS Example Dataset Z +
  • Calculation of time weighted average concentrations with mkin
    • @@ -60,7 +63,10 @@ order of increasing model complexity, i.e. SFO, then IORE, and finally DFOP.">Example evaluation of NAFTA SOP Attachment examples
  • - Some benchmark timings + Benchmark timings for mkin +
    • +
  • + Benchmark timings for saem.mmkin
  • @@ -95,10 +101,10 @@ order of increasing model complexity, i.e. SFO, then IORE, and finally DFOP.

    - 
    nafta(ds, title = NA, quiet = FALSE, ...)
-
-# S3 method for nafta
-print(x, quiet = TRUE, digits = 3, ...)
    + 
    nafta(ds, title = NA, quiet = FALSE, ...)
+
+# S3 method for nafta
+print(x, quiet = TRUE, digits = 3, ...)
    @@ -120,22 +126,35 @@ Degradation time values specified by the time argument, one column called "name" with the grouping of the observed values, and finally one column of observed values called "value".

    + +
    title

    Optional title of the dataset

    + +
    quiet

    Should the evaluation text be shown?

    + +
    ...

    Further arguments passed to mmkin (not for the printing method).

    + +
    x

    An nafta object.

    + +
    digits

    Number of digits to be used for printing parameters and dissipation times.

    +

    Value

    -

    An list of class nafta. The list element named "mmkin" is the + + +

    An list of class nafta. The list element named "mmkin" is the mmkin object containing the fits of the three models. The list element named "title" contains the title of the dataset used. The list element "data" contains the dataset used in the fits.

    @@ -147,13 +166,13 @@ list element "data" contains the dataset used in the fits.

    Examples

    - 
    
-  nafta_evaluation <- nafta(NAFTA_SOP_Appendix_D, cores = 1)
+    
    
+  nafta_evaluation <- nafta(NAFTA_SOP_Appendix_D, cores = 1)
 #> The SFO model is rejected as S_SFO is equal or higher than the critical value S_c
 #> The representative half-life of the IORE model is longer than the one corresponding
 #> to the terminal degradation rate found with the DFOP model.
 #> The representative half-life obtained from the DFOP model may be used
-  print(nafta_evaluation)
+  print(nafta_evaluation)
 #> Sums of squares:
 #>       SFO      IORE      DFOP 
 #> 1378.6832  615.7730  517.8836 
@@ -192,9 +211,9 @@ list element "data" contains the dataset used in the fits.
    
 #> 
 #> Representative half-life:
 #> [1] 841.41
-  plot(nafta_evaluation)
+  plot(nafta_evaluation)
 
-
+
    @@ -209,7 +228,7 @@ list element "data" contains the dataset used in the fits.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.6.

    -- cgit v1.2.1