From c6079a807e2b400fe0c772603392aeacd887da2f Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 8 May 2019 20:57:48 +0200 Subject: Add functionality to plot the error model by plotting squared residuals against predicted values, and showing the variance function used in the fitted error model. Rebuild docs --- docs/reference/mkinerrplot.html | 250 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 250 insertions(+) create mode 100644 docs/reference/mkinerrplot.html (limited to 'docs/reference/mkinerrplot.html') diff --git a/docs/reference/mkinerrplot.html b/docs/reference/mkinerrplot.html new file mode 100644 index 00000000..66da40b5 --- /dev/null +++ b/docs/reference/mkinerrplot.html @@ -0,0 +1,250 @@ + + + + + + + + +Function to plot squared residuals and the error model for an mkin object — mkinerrplot • mkin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Function to plot squared residuals and the error model for an mkin object

+ + +
+ +
+ +

This function plots the squared residuals for the specified subset of the + observed variables from an mkinfit object. In addition, one or more + dashed line(s) show the fitted error model. + A combined plot of the fitted model and this error model plot can be + obtained with plot.mkinfit + using the argument show_errplot = TRUE.

+ +
+ + 
mkinerrplot(object,
+    obs_vars = names(object$mkinmod$map),
+    xlim = c(0, 1.1 * max(object$data$predicted)),
+    xlab = "Predicted", ylab = "Squared residual",
+    maxy = "auto", legend= TRUE, lpos = "topright",
+    col_obs = "auto", pch_obs = "auto",
+    ...)
+ +

Arguments

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
object

A fit represented in an mkinfit object.

obs_vars

A character vector of names of the observed variables for which residuals + should be plotted. Defaults to all observed variables in the model

xlim

plot range in x direction.

xlab

Label for the x axis.

ylab

Label for the y axis.

maxy

Maximum value of the residuals. This is used for the scaling of + the y axis and defaults to "auto".

legend

Should a legend be plotted?

lpos

Where should the legend be placed? Default is "topright". Will be passed on to + legend.

col_obs

Colors for the observed variables.

pch_obs

Symbols to be used for the observed variables.

…

further arguments passed to plot.

+ +

Value

+ +

Nothing is returned by this function, as it is called for its side effect, namely to produce a plot.

+ +

See also

+ +

mkinplot, for a way to plot the data and the fitted lines of the + mkinfit object.

+ + +

Examples

+ 
model <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
#> Successfully compiled differential equation model from auto-generated C code.
fit <- mkinfit(model, FOCUS_2006_D, error_model = "tc", quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
mkinerrplot(fit)
+
+ +
+ + +
+ + + + + + -- cgit v1.2.1