aboutsummaryrefslogtreecommitdiff
path: root/man/mkinresplot.Rd
blob: 27e1322f811cf7cd71d8527943b05cc1bf1fe764 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
% 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
}

Contact - Imprint