From af2e1540cdad2fd00bb6216a38a754ff748629ad Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 25 Oct 2019 02:10:08 +0200 Subject: Static documentation rebuilt by pkgdown --- docs/reference/mkinresplot.html | 72 +++++++++++++++++++---------------------- 1 file changed, 34 insertions(+), 38 deletions(-) (limited to 'docs/reference/mkinresplot.html') diff --git a/docs/reference/mkinresplot.html b/docs/reference/mkinresplot.html index eea5b218..1ac2cdbe 100644 --- a/docs/reference/mkinresplot.html +++ b/docs/reference/mkinresplot.html @@ -8,11 +8,13 @@ Function to plot residuals stored in an mkin object — mkinresplot • mkin + + @@ -32,16 +34,17 @@ - - + + + @@ -112,7 +115,6 @@ News - @@ -134,23 +136,17 @@
- -

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.

- +

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.

-
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",
-    col_obs = "auto", pch_obs = "auto",
-    frame = TRUE,
-    ...)
- +
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",
+  col_obs = "auto", pch_obs = "auto", frame = TRUE, ...)
+

Arguments

@@ -160,8 +156,9 @@ - + @@ -173,12 +170,13 @@ - + - + @@ -186,8 +184,8 @@ - + @@ -206,29 +204,27 @@
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

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

xlim
ylab

Label for the y axis. Defaults to "Residual [% of applied radioactivity]".

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".

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

legend
lpos

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

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

col_obs

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.

- +

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.

- +

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, quiet = TRUE)
#> Warning: Observations with value of zero were removed from the data
mkinresplot(fit, "m1")
+
+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)
#> Warning: Observations with value of zero were removed from the data
mkinresplot(fit, "m1")
+