First version published on CRAN

git-svn-id: http://kriemhild.uft.uni-bremen.de/svn/drfit@1 d1b72e20-2ee0-0310-a1c4-ad5adbbefcdc

1 files changed, 86 insertions, 0 deletions

diff --git a/man/drplot.Rd b/man/drplot.Rd
new file mode 100644
index 0000000..bb4826e
--- /dev/null
+++ b/man/drplot.Rd
@@ -0,0 +1,86 @@
+\name{drplot}
+\alias{drplot}
+\title{Plot dose-response models}
+\description{
+	Produce graphics of dose-response data and dose-response relationships 
+  either combined or separately, for one or more substances.
+}
+\usage{
+  drplot(drresults, data, dtype, alpha, path, fileprefix, overlay,
+    postscript, color, colors, fitcolors)
+}
+\arguments{
+  \item{drresults}{
+    A data frame as returned from \code{\link{drfit}}.
+    }
+  \item{data}{ 
+    A data frame as returned from \code{\link{drdata}}.  If data is to be
+    plotted, the data frame has to contain at least a factor called
+    "substance", a vector called "unit" containing the unit used for the dose,
+    a column "response" with the response values of the test system normalized
+    between 0 and 1, a column "dose" with the numeric dose values and a factor
+    called "dosefactor" containing the dose as a factor. If plotting of the data is 
+    not required, data can be set to FALSE.
+    }
+  \item{dtype}{
+    A string describing if the raw data should be plotted ("raw"), or 
+    an error bar should be constructed from the standard deviations of the
+    responses at each dose level ("std", default value) or from the confidence
+    intervals ("conf"). Of course, dtype only makes a difference, if a valid data
+    object has been referenced.
+    }
+  \item{alpha}{
+    The confidence level, defaulting to 0.95, only used if dtype "conf" has been
+    chosen.
+    }
+  \item{path}{
+    The path where graphic files should be put if any are produced. Defaults
+    to "./" i.e. the current working directory of R.
+    }
+  \item{fileprefix}{
+    A string which will form the beginning of each filename, if graphic files are 
+    created. Defaults to "drplot".
+    }
+  \item{overlay}{
+    If TRUE, all output will be put into one graph, otherwise a separate graph
+    will be created for each substance. In the latter case, on-screen display
+    (postscript=FALSE) only works correctly for data plots. Dose-response models
+    will all be put into the last graph in this case.
+    }
+  \item{postscript}{
+    If TRUE, (a) postscript graph(s) will be created. Otherwise, graphics will be
+    displayed with a screen graphics device.
+    }
+  \item{color}{
+    If TRUE, a sensible selection of colors will be attempted. If false, everything
+    will be drawn in black
+    }
+  \item{colors}{
+    This is a vector of colors, defaulting to 1:8, used for plotting the data.
+    }
+  \item{fitcolors}{
+    Here you can specify a palette for the colors of the dose-response fits. The 
+    default value is "default", which produces rainbow colors.
+    }
+}
+\value{
+  \item{results}{
+      A data frame containing at least one line for each substance. If the data did not
+      show a mean response < 0.5 at the highest dose level, the modeltype is set to "none".
+      Every successful fit is reported in one line. Parameters of the fitted curves are only
+      reported if the fitted EC50 is not higher than the highest dose.}
+    
+} 
+\examples{
+\dontrun{data(antifoul)}
+\dontrun{r <- drfit(antifoul)}
+\dontrun{format(r,digits=2)}
+}
+\author{
+  Johannes Ranke 
+  \email{jranke@uni-bremen.de} 
+  \url{http://www.uft.uni-bremen.de/chemie/ranke}
+}
+\keyword{models}
+\keyword{regression}
+\keyword{nonlinear}