diff options
| author | jranke <jranke@edb9625f-4e0d-4859-8d74-9fd3b1da38cb> | 2012-03-15 15:54:14 +0000 |
|---|---|---|
| committer | jranke <jranke@edb9625f-4e0d-4859-8d74-9fd3b1da38cb> | 2012-03-15 15:54:14 +0000 |
| commit | 1718d434efae26de02754c6622c43f4dc9e624b9 (patch) | |
| tree | c2dafe942f65e94cd43e1ba17933b667f284d154 /man/mkinresplot.Rd | |
| parent | 2b244ef7d3cbebaaa653d8c8ac87090e34525f7a (diff) | |
Update kinfit and mkin to the latest version published on BerliOS.
git-svn-id: svn+ssh://svn.r-forge.r-project.org/svnroot/kinfit/pkg/mkin@17 edb9625f-4e0d-4859-8d74-9fd3b1da38cb
Diffstat (limited to 'man/mkinresplot.Rd')
| -rw-r--r-- | man/mkinresplot.Rd | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/man/mkinresplot.Rd b/man/mkinresplot.Rd new file mode 100644 index 00000000..0b48692c --- /dev/null +++ b/man/mkinresplot.Rd @@ -0,0 +1,64 @@ +\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.
+}
+\usage{
+ mkinresplot(object, obs_vars = vector(),
+ xlab = "Time [days]", ylab = "Residual [\% of applied radioactivity]",
+ maxabs = "auto", legend = TRUE, lpos = "topright", ...)
+}
+\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.
+}
+ \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{\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{
+ Katrin Lindenberger and Johannes Ranke
+}
+
+\seealso{
+ \code{\link{mkinplot}}, for a way to plot the data and the fitted lines of the
+ mkinfit object. }
+\examples{
+data <- mkin_wide_to_long(schaefer07_complex_case, time = "time")
+model <- mkinmod(
+ parent = list(type = "SFO", to = c("A1", "B1", "C1"), sink = FALSE),
+ A1 = list(type = "SFO", to = "A2"),
+ B1 = list(type = "SFO"),
+ C1 = list(type = "SFO"),
+ A2 = list(type = "SFO"))
+\dontrun{fit <- mkinfit(model, data, plot=TRUE)}
+\dontrun{mkinresplot(fit, "A1")}
+}
+\keyword{ hplot }
|