From c6079a807e2b400fe0c772603392aeacd887da2f Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
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
---
 man/mkinerrplot.Rd | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 man/mkinerrplot.Rd

(limited to 'man/mkinerrplot.Rd')

diff --git a/man/mkinerrplot.Rd b/man/mkinerrplot.Rd
new file mode 100644
index 00000000..4cbb5eb7
--- /dev/null
+++ b/man/mkinerrplot.Rd
@@ -0,0 +1,75 @@
+\name{mkinerrplot}
+\alias{mkinerrplot}
+\title{
+  Function to plot squared residuals and the error model for an mkin object
+}
+\description{
+  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 \code{\link{plot.mkinfit}}
+  using the argument \code{show_errplot = TRUE}.
+}
+\usage{
+  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{
+  \item{object}{
+    A fit represented in an \code{\link{mkinfit}} object.
+  }
+  \item{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
+  }
+  \item{xlim}{
+    plot range in x direction.
+  }
+  \item{xlab}{
+    Label for the x axis.
+  }
+  \item{ylab}{
+    Label for the y axis.
+  }
+  \item{maxy}{
+    Maximum value of the residuals. This is used for the scaling of
+    the y axis and defaults to "auto".
+  }
+  \item{legend}{
+    Should a legend be plotted?
+  }
+  \item{lpos}{
+    Where should the legend be placed? Default is "topright". Will be passed on to
+    \code{\link{legend}}.
+  }
+  \item{col_obs}{
+    Colors for the observed variables.
+  }
+  \item{pch_obs}{
+    Symbols to be used for the observed variables.
+  }
+  \item{\dots}{
+   further arguments passed to \code{\link{plot}}.
+  }
+}
+\value{
+  Nothing is returned by this function, as it is called for its side effect, namely to produce a plot.
+}
+\author{
+  Johannes Ranke
+}
+\seealso{
+ \code{\link{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"))
+fit <- mkinfit(model, FOCUS_2006_D, error_model = "tc", quiet = TRUE)
+mkinerrplot(fit)
+}
+\keyword{ hplot }
-- 
cgit v1.2.1