From 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Fri, 25 Oct 2019 00:37:42 +0200
Subject: Use roxygen for functions and methods

---
 man/mkinresplot.Rd | 141 ++++++++++++++++++++++++-----------------------------
 1 file changed, 65 insertions(+), 76 deletions(-)

(limited to 'man/mkinresplot.Rd')

diff --git a/man/mkinresplot.Rd b/man/mkinresplot.Rd
index e788d836..27e1322f 100644
--- a/man/mkinresplot.Rd
+++ b/man/mkinresplot.Rd
@@ -1,76 +1,65 @@
-\name{mkinresplot}
-\alias{mkinresplot}
-\title{
-  Function to plot residuals stored in an mkin object
-}
-\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 \code{\link{plot.mkinfit}}
-  using the argument \code{show_residuals = TRUE}.
-}
-\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", 
-    col_obs = "auto", pch_obs = "auto",
-    frame = TRUE,
-    ...)
-}
-\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. Defaults to "Time [days]".
-  }
-  \item{ylab}{
-    Label for the y axis. Defaults to "Residual [\% of applied radioactivity]".
-  }
-  \item{maxabs}{
-    Maximum absolute 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? Defaults to "TRUE".
-  }
-  \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{frame}{
-    Should a frame be drawn around the plots?
-  }
-  \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, quiet = TRUE)
-mkinresplot(fit, "m1")
-}
-\keyword{ hplot }
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/mkinresplot.R
+\name{mkinresplot}
+\alias{mkinresplot}
+\title{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",
+  col_obs = "auto", pch_obs = "auto", frame = TRUE, ...)
+}
+\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. Defaults to "Time [days]".}
+
+\item{ylab}{Label for the y axis. Defaults to "Residual [\% of applied
+radioactivity]".}
+
+\item{maxabs}{Maximum absolute 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? Defaults to "TRUE".}
+
+\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{frame}{Should a frame be drawn around the plots?}
+
+\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.
+}
+\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 \code{\link{plot.mkinfit}} using the
+argument \code{show_residuals = TRUE}.
+}
+\examples{
+
+model <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
+fit <- mkinfit(model, FOCUS_2006_D, quiet = TRUE)
+mkinresplot(fit, "m1")
+
+}
+\seealso{
+\code{\link{mkinplot}}, for a way to plot the data and the fitted
+  lines of the mkinfit object.
+}
+\author{
+Johannes Ranke
+}
-- 
cgit v1.2.1