From 7c62da1269e8910a210ba1917d4dc62d186d5606 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 6 Oct 2016 09:40:35 +0200 Subject: Static documentation rebuilt by pkgdown::build_site() --- docs/mkinresplot.html | 163 -------------------------------------------------- 1 file changed, 163 deletions(-) delete mode 100644 docs/mkinresplot.html (limited to 'docs/mkinresplot.html') diff --git a/docs/mkinresplot.html b/docs/mkinresplot.html deleted file mode 100644 index 09f4f7b9..00000000 --- a/docs/mkinresplot.html +++ /dev/null @@ -1,163 +0,0 @@ - - - - -mkinresplot. mkin 0.9.44.9000 - - - - - - - - - - - - - - - -
-
-
- mkin 0.9.44.9000 -
- -
-
-
-
- - -
-
- -
- -

- Function to plot residuals stored in an mkin object -

- -
-
-

Usage

- 
mkinresplot(object,
-    obs_vars = names(object$mkinmod$map),
-    xlim = c(0, 1.1 * max(object$data$time)),
-    xlab = "Time", ylab = "Residual",
-    maxabs = "auto", legend = TRUE, lpos = "topright", ...)
- -

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. Defaults to "Time [days]". -
-
ylab
-
- Label for the y axis. Defaults to "Residual [% of applied radioactivity]". -
-
maxabs
-
- Maximum absolute value of the residuals. This is used for the scaling of - the y axis and defaults to "auto". -
-
legend
-
- Should a legend be plotted? Defaults to "TRUE". -
-
lpos
-
- Where should the legend be placed? Default is "topright". Will be passed on to - legend.
-
...
-
- further arguments passed to plot. -
-
- -
-

Description

- -

This function plots the residuals for the specified subset of the - observed variables from an mkinfit object. A combined plot of the fitted - model and the residuals can be obtained using plot.mkinfit - using the argument show_residuals = TRUE.

- -
- -
-

Value

- -

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

- -
- -

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, quiet = TRUE)
-mkinresplot(fit, "m1")

-
-
-
- - -

See also

-

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

- - - -

Author

- - Johannes Ranke - - -
-
- - -
- - \ No newline at end of file -- cgit v1.2.1