Option to add residual plot to plot.mkinfit

2 files changed, 19 insertions, 6 deletions

diff --git a/man/mkinresplot.Rd b/man/mkinresplot.Rd
index 8e3f18a4..3f53dd1b 100644
--- a/man/mkinresplot.Rd
+++ b/man/mkinresplot.Rd
@@ -5,10 +5,13 @@
 }

 \description{

   This function plots the residuals for the specified subset of the 

-  observed variables from an mkinfit object.

+  observed variables from an mkinfit object. A combined plot of the fitted

+  model and the residuals can be obtained using \code{\link{plot.mkinfit}}

+  using the argument \code{show_residuals = TRUE}.

 }

 \usage{

-  mkinresplot(object, obs_vars = vector(), 

+  mkinresplot(object, 

+    obs_vars = names(object$mkinmod$map),

     xlab = "Time", ylab = "Residual", 

     maxabs = "auto", legend = TRUE, lpos = "topright", ...)

 }

@@ -18,7 +21,7 @@
 }

   \item{obs_vars}{

     A character vector of names of the observed variables for which residuals

-    should be plotted.

+    should be plotted. Defaults to all observed variables in the model

 }

   \item{xlab}{

     Label for the x axis. Defaults to "Time [days]".

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

 }

 \author{

-  Katrin Lindenberger and Johannes Ranke

+  Johannes Ranke

 }

 

 \seealso{

diff --git a/man/plot.mkinfit.Rd b/man/plot.mkinfit.Rd
index 4ae82a50..7009e7d7 100644
--- a/man/plot.mkinfit.Rd
+++ b/man/plot.mkinfit.Rd
@@ -12,10 +12,13 @@
 \method{plot}{mkinfit}(x, fit = x,
   obs_vars = names(fit$mkinmod$map),
   xlab = "Time", ylab = "Observed", 
-  xlim = range(fit$data$time), ylim = c(0, max(fit$data$observed, na.rm = TRUE)),
+  xlim = range(fit$data$time),
+  ylim = "default",
   col_obs = 1:length(fit$mkinmod$map), pch_obs = col_obs, 
   lty_obs = rep(1, length(fit$mkinmod$map)),
-  add = FALSE, legend = !add, lpos = "topright", inset = c(0.05, 0.05), ...)
+  add = FALSE, legend = !add,
+  show_residuals = FALSE, maxabs = "auto",
+  lpos = "topright", inset = c(0.05, 0.05), \dots)
 }
 \arguments{
   \item{x}{
@@ -56,6 +59,13 @@
   \item{legend}{
     should a legend be added to the plot?
   }
+  \item{show_residuals}{
+    should residuals be shown in the lower third of the plot?
+  }
+  \item{maxabs}{
+    Maximum absolute value of the residuals. This is used for the scaling of
+    the y axis and defaults to "auto".
+  }
   \item{lpos}{
     position of the legend. Passed to \code{\link{legend}} as the first argument.
   }