From ccc70e82af4ba435f0a71ba1ae4e0e92045c3852 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 5 May 2017 12:46:31 +0200 Subject: Static docs except articles rebuilt with current pkgdown --- docs/reference/plot.mkinfit.html | 203 ++++++++++++++++++++------------------- 1 file changed, 103 insertions(+), 100 deletions(-) (limited to 'docs/reference/plot.mkinfit.html') diff --git a/docs/reference/plot.mkinfit.html b/docs/reference/plot.mkinfit.html index e77b7b54..2126c36d 100644 --- a/docs/reference/plot.mkinfit.html +++ b/docs/reference/plot.mkinfit.html @@ -6,8 +6,7 @@ - - — plot.mkinfit • mkin +Plot the observed data and the fitted model of an mkinfit object — plot.mkinfit • mkin @@ -26,12 +25,14 @@ - + + + @@ -71,6 +72,9 @@
  • Performance benefit by using compiled model definitions in mkin
    • +
  • + Calculation of time weighted average concentrations with mkin +
  • @@ -96,21 +100,19 @@
    -

    -

    +

    Plot the observed data and the fitted model of an mkinfit object

    Solves the differential equations with the optimised and fixed parameters from a previous successful call to mkinfit and plots the observed data together with the solution of the fitted model.

    - -

    If the current plot device is a tikz device, +

    If the current plot device is a tikz device, then latex is being used for the formatting of the chi2 error level, if show_errmin = TRUE.

    - 
    # S3 method for mkinfit
+    
    # S3 method for mkinfit
 plot(x, fit = x,
   obs_vars = names(fit$mkinmod$map),
   xlab = "Time", ylab = "Observed",
@@ -126,100 +128,101 @@ plot(x, fit = x,
 plot_sep(fit, sep_obs = TRUE,  show_residuals = TRUE, show_errmin = TRUE, …)
    
     
     
     Arguments
    
-    
    
-      
    x
    
-      
    
-    Alias for fit introduced for compatibility with the generic S3 method.
-  
    
-      
    fit
    
-      
    
-    An object of class mkinfit.
-  
    
-      
    obs_vars
    
-      
    
-    A character vector of names of the observed variables for which the
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    x
    Alias for fit introduced for compatibility with the generic S3 method.
    fit
    An object of class mkinfit.
    obs_vars
    A character vector of names of the observed variables for which the
     data and the model should be plotted. Defauls to all observed variables
-    in the model.
-  
-      
    xlab
    
-      
    
-    Label for the x axis.
-  
    
-      
    ylab
    
-      
    
-    Label for the y axis.
-  
    
-      
    xlim
    
-      
    
-    Plot range in x direction.
-  
    
-      
    ylim
    
-      
    
-    Plot range in y direction.
-  
    
-      
    col_obs
    
-      
    
-    Colors used for plotting the observed data and the corresponding model prediction lines.
-  
    
-      
    pch_obs
    
-      
    
-    Symbols to be used for plotting the data.
-  
    
-      
    lty_obs
    
-      
    
-    Line types to be used for the model predictions.
-  
    
-      
    add
    
-      
    
-    Should the plot be added to an existing plot?
-  
    
-      
    legend
    
-      
    
-    Should a legend be added to the plot?
-  
    
-      
    show_residuals
    
-      
    
-    Should residuals be shown? If only one plot of the fits is shown, the
+    in the model.
    xlab
    Label for the x axis.
    ylab
    Label for the y axis.
    xlim
    Plot range in x direction.
    ylim
    Plot range in y direction.
    col_obs
    Colors used for plotting the observed data and the corresponding model prediction lines.
    pch_obs
    Symbols to be used for plotting the data.
    lty_obs
    Line types to be used for the model predictions.
    add
    Should the plot be added to an existing plot?
    legend
    Should a legend be added to the plot?
    show_residuals
    Should residuals be shown? If only one plot of the fits is shown, the
     residual plot is in the lower third of the plot? Otherwise, i.e. if
-    "sep_obs" is given, the residual plots will be located to the right of
-    the plots of the fitted curves.
-  
-      
    maxabs
    
-      
    
-    Maximum absolute value of the residuals. This is used for the scaling of
-    the y axis and defaults to "auto".
-  
    
-      
    sep_obs
    
-      
    
-    Should the observed variables be shown in separate subplots? If yes, residual plots
-    requested by "show_residuals" will be shown next to, not below the plot of the fits.
-  
    
-      
    rel.height.middle
    
-      
    
-    The relative height of the middle plot, if more than two rows of plots are shown.
-  
    
-      
    lpos
    
-      
    
-    Position(s) of the legend(s). Passed to legend as the first argument.
-    If not length one, this should be of the same length as the obs_var argument.
-  
    
-      
    inset
    
-      
    
-    Passed to legend if applicable.
-  
    
-      
    show_errmin
    
-      
    
-    Should the FOCUS chi2 error value be shown in the upper margin of the plot?
-  
    
-      
    errmin_digits
    
-      
    
-    The number of significant digits for rounding the FOCUS chi2 error percentage.
-  
    
-      
    …
    
-      
    
-    Further arguments passed to plot.
-  
    
-    
+    "sep_obs" is given, the residual plots will be located to the right of
+    the plots of the fitted curves.
    maxabs
    Maximum absolute value of the residuals. This is used for the scaling of
+    the y axis and defaults to "auto".
    sep_obs
    Should the observed variables be shown in separate subplots? If yes, residual plots
+    requested by "show_residuals" will be shown next to, not below the plot of the fits.
    rel.height.middle
    The relative height of the middle plot, if more than two rows of plots are shown.
    lpos
    Position(s) of the legend(s). Passed to legend as the first argument.
+    If not length one, this should be of the same length as the obs_var argument.
    inset
    Passed to legend if applicable.
    show_errmin
    Should the FOCUS chi2 error value be shown in the upper margin of the plot?
    errmin_digits
    The number of significant digits for rounding the FOCUS chi2 error percentage.
    …
    Further arguments passed to plot.
    
     
     
    Value
    
 
-- 
cgit v1.2.1