# Xpose 4
# An R-based population pharmacokinetic/
# pharmacodynamic model building aid for NONMEM.
# Copyright (C) 1998-2004 E. Niclas Jonsson and Mats Karlsson.
# Copyright (C) 2005-2008 Andrew C. Hooker, Justin J. Wilkins,
# Mats O. Karlsson and E. Niclas Jonsson.
# Copyright (C) 2009-2010 Andrew C. Hooker, Mats O. Karlsson and
# E. Niclas Jonsson.
# This file is a part of Xpose 4.
# Xpose 4 is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public License
# as published by the Free Software Foundation, either version 3
# of the License, or (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public License
# along with this program. A copy can be cound in the R installation
# directory under \share\licenses. If not, see http://www.gnu.org/licenses/.
#' Dependent variable vs population predictions, conditioned on independent
#' variable, for Xpose 4
#'
#' This is a plot of the dependent variable (DV) vs population predictions
#' (PRED) conditioned by the independent variable, a specific function in Xpose
#' 4. It is a wrapper encapsulating arguments to the \code{xpose.plot.default}
#' function. Most of the options take their default values from xpose.data
#' object but may be overridden by supplying them as arguments.
#'
#' A wide array of extra options controlling \code{xyplot}s are available. See
#' \code{\link{xpose.plot.default}} and \code{\link{xpose.panel.default}} for
#' details.
#'
#' @param object An xpose.data object.
#' @param abline Vector of arguments to the \code{\link[lattice]{panel.abline}}
#' function. No abline is drawn if \code{NULL}.
#' @param smooth Logical value indicating whether an x-y smooth should be
#' superimposed. The default is TRUE.
#' @param \dots Other arguments passed to \code{link{xpose.plot.default}}.
#' @return Returns a stack of xyplots of DV vs PRED, conditioned on the
#' independent variable.
#' @author E. Niclas Jonsson, Mats Karlsson, Andrew Hooker & Justin Wilkins
#' @seealso \code{\link{dv.vs.pred}}, \code{\link{xpose.plot.default}},
#' \code{\link{xpose.panel.default}}, \code{\link[lattice]{xyplot}},
#' \code{\link{xpose.prefs-class}}, \code{\link{xpose.data-class}}
#' @keywords methods
#' @examples
#' dv.vs.pred.by.idv(simpraz.xpdb)
#'
#' @export dv.vs.pred.by.idv
#' @family specific functions
dv.vs.pred.by.idv <-
function(object,
#xlb = NULL,
#ylb = NULL,
#onlyfirst=FALSE,
#inclZeroWRES=FALSE,
#subset=xsubset(object),
abline=c(0,1),
#abllwd = object@Prefs@Graph.prefs$abllwd,
#abllty = object@Prefs@Graph.prefs$abllty,
#ablcol = object@Prefs@Graph.prefs$ablcol,
#mirror=FALSE,
#seed = NULL,
smooth=TRUE,
...) {
## Make sure we have the necessary variables defined in the
## object.
if(is.null(check.vars(c("dv","pred","idv"),object))) {
return(NULL)
}
xplot <- xpose.plot.default(xvardef("pred",object),
xvardef("dv",object),
object,
#main=main,
#xlb = xlb,
#ylb=ylb,
abline=abline,
#abllwd=abllwd,
by=xvardef("idv",object),
#subset=subset,
smooth=smooth,
...)
return(xplot)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.