From 91a5834dd701211f929fd25419dc34561ce3b4e7 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 14 Feb 2025 09:15:20 +0100 Subject: Initialize dev docs --- docs/dev/reference/mkinresplot.html | 203 ++++++++++++++++++++++++++++++++++++ 1 file changed, 203 insertions(+) create mode 100644 docs/dev/reference/mkinresplot.html (limited to 'docs/dev/reference/mkinresplot.html') diff --git a/docs/dev/reference/mkinresplot.html b/docs/dev/reference/mkinresplot.html new file mode 100644 index 00000000..b9de393d --- /dev/null +++ b/docs/dev/reference/mkinresplot.html @@ -0,0 +1,203 @@ + +Function to plot residuals stored in an mkin object — mkinresplot • mkin + Skip to contents + + +
+
+
+ +

Function to plot residuals stored in an mkin object

+ Source: R/mkinresplot.R +
mkinresplot.Rd
+
+ +
+

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.

+
+ +
+

Usage

+ 
mkinresplot(
+  object,
+  obs_vars = names(object$mkinmod$map),
+  xlim = c(0, 1.1 * max(object$data$time)),
+  standardized = FALSE,
+  xlab = "Time",
+  ylab = ifelse(standardized, "Standardized residual", "Residual"),
+  maxabs = "auto",
+  legend = TRUE,
+  lpos = "topright",
+  col_obs = "auto",
+  pch_obs = "auto",
+  frame = TRUE,
+  ...
+)
+
+ +
+

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.

+ + +
standardized
+

Should the residuals be standardized by dividing by the +standard deviation given by the error model of the fit?

+ + +
xlab
+

Label for the x axis.

+ + +
ylab
+

Label for the y axis.

+ + +
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?

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

+ + +
frame
+

Should a frame be drawn around the plots?

+ + +
...
+

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, and plot_res for a function +combining the plot of the fit and the residual plot.

+
+
+

Author

+

Johannes Ranke and Katrin Lindenberger

+
+ +
+

Examples

+ 

+model <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
+#> Temporary DLL for differentials generated and loaded
+fit <- mkinfit(model, FOCUS_2006_D, quiet = TRUE)
+#> Warning: Observations with value of zero were removed from the data
+mkinresplot(fit, "m1")
+
+
+
+
+
+ + +
+ + + + + + + -- cgit v1.2.1