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/plot.mmkin.html | 113 ++++++++++++++++++++++++++--------------- 1 file changed, 73 insertions(+), 40 deletions(-) (limited to 'docs/reference/plot.mmkin.html') diff --git a/docs/reference/plot.mmkin.html b/docs/reference/plot.mmkin.html index 3dd0203b..30d0406e 100644 --- a/docs/reference/plot.mmkin.html +++ b/docs/reference/plot.mmkin.html @@ -21,7 +21,7 @@ the fit of at least one model to the same dataset is shown."> mkin - 1.1.0 + 1.2.0 @@ -48,11 +48,14 @@ the fit of at least one model to the same dataset is shown.">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 @@ the fit of at least one model to the same dataset is shown.">Example evaluation of NAFTA SOP Attachment examples
  • - Some benchmark timings + Benchmark timings for mkin +
    • +
  • + Benchmark timings for saem.mmkin
  • @@ -94,22 +100,22 @@ the fit of at least one model to the same dataset is shown.

    - 
    # S3 method for mmkin
-plot(
-  x,
-  main = "auto",
-  legends = 1,
-  resplot = c("time", "errmod"),
-  ylab = "Residue",
-  standardized = FALSE,
-  show_errmin = TRUE,
-  errmin_var = "All data",
-  errmin_digits = 3,
-  cex = 0.7,
-  rel.height.middle = 0.9,
-  ymax = "auto",
-  ...
-)
    + 
    # S3 method for mmkin
+plot(
+  x,
+  main = "auto",
+  legends = 1,
+  resplot = c("time", "errmod"),
+  ylab = "Residue",
+  standardized = FALSE,
+  show_errmin = TRUE,
+  errmin_var = "All data",
+  errmin_digits = 3,
+  cex = 0.7,
+  rel.height.middle = 0.9,
+  ymax = "auto",
+  ...
+)
    @@ -117,43 +123,70 @@ the fit of at least one model to the same dataset is shown.

    x

    An object of class mmkin, with either one row or one column.

    + +
    main

    The main title placed on the outer margin of the plot.

    + +
    legends

    An index for the fits for which legends should be shown.

    + +
    resplot

    Should the residuals plotted against time, using mkinresplot, or as squared residuals against predicted values, with the error model, using mkinerrplot.

    + +
    ylab

    Label for the y axis.

    + +
    standardized

    Should the residuals be standardized? This option is passed to mkinresplot, it only takes effect if resplot = "time".

    + +
    show_errmin

    Should the chi2 error level be shown on top of the plots to the left?

    + +
    errmin_var

    The variable for which the FOCUS chi2 error value should be shown.

    + +
    errmin_digits

    The number of significant digits for rounding the FOCUS chi2 error percentage.

    + +
    cex

    Passed to the plot functions and mtext.

    + +
    rel.height.middle

    The relative height of the middle plot, if more than two rows of plots are shown.

    + +
    ymax

    Maximum y axis value for plot.mkinfit.

    + +
    ...

    Further arguments passed to plot.mkinfit and mkinresplot.

    +

    Value

    -

    The function is called for its side effect.

    + + +

    The function is called for its side effect.

    Details

    @@ -167,32 +200,32 @@ latex is being used for the formatting of the chi2 error level.

    Examples

    - 
    
-  # \dontrun{
-  # Only use one core not to offend CRAN checks
-  fits <- mmkin(c("FOMC", "HS"),
-                list("FOCUS B" = FOCUS_2006_B, "FOCUS C" = FOCUS_2006_C), # named list for titles
-                cores = 1, quiet = TRUE, error_model = "tc")
+    
    
+  # \dontrun{
+  # Only use one core not to offend CRAN checks
+  fits <- mmkin(c("FOMC", "HS"),
+                list("FOCUS B" = FOCUS_2006_B, "FOCUS C" = FOCUS_2006_C), # named list for titles
+                cores = 1, quiet = TRUE, error_model = "tc")
 #> Warning: Optimisation did not converge:
 #> iteration limit reached without convergence (10)
-  plot(fits[, "FOCUS C"])
+  plot(fits[, "FOCUS C"])
 
-  plot(fits["FOMC", ])
+  plot(fits["FOMC", ])
 
-  plot(fits["FOMC", ], show_errmin = FALSE)
+  plot(fits["FOMC", ], show_errmin = FALSE)
 
-
-  # We can also plot a single fit, if we like the way plot.mmkin works, but then the plot
-  # height should be smaller than the plot width (this is not possible for the html pages
-  # generated by pkgdown, as far as I know).
-  plot(fits["FOMC", "FOCUS C"]) # same as plot(fits[1, 2])
+
+  # We can also plot a single fit, if we like the way plot.mmkin works, but then the plot
+  # height should be smaller than the plot width (this is not possible for the html pages
+  # generated by pkgdown, as far as I know).
+  plot(fits["FOMC", "FOCUS C"]) # same as plot(fits[1, 2])
 
-
-  # Show the error models
-  plot(fits["FOMC", ], resplot = "errmod")
+
+  # Show the error models
+  plot(fits["FOMC", ], resplot = "errmod")
 
-  # }
-
+  # }
+
    @@ -207,7 +240,7 @@ latex is being used for the formatting of the chi2 error level.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.6.

    -- cgit v1.2.1