Added the documentation for linearlogisf and checksubstance.

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

2 files changed, 81 insertions, 0 deletions

diff --git a/man/checksubstance.Rd b/man/checksubstance.Rd
new file mode 100644
index 0000000..e9915e7
--- /dev/null
+++ b/man/checksubstance.Rd
@@ -0,0 +1,45 @@
+\name{checksubstance}
+\alias{checksubstance}
+\title{Check raw data for a specified substance}
+\description{
+  Report metadata for a specified substance from a specified database, and plot
+  the data.
+}
+\usage{
+  checksubstance(substance,db="cytotox",experimentator="%",celltype="%",whereClause="1",ok="%")
+}
+\arguments{
+  \item{substance}{
+    The name of the substance identifying it within the database.}
+  \item{db}{
+    The database to be used. Currently, the databases "cytotox" and "enzymes"
+    of the UFT Department of Bioorganic Chemistry are supported (default is
+    "cytotox").} 
+  \item{experimentator}{
+    The name of the experimentator whose data is to be used. Default is "\%", which
+    means that data from all experimentators are shown.}
+  \item{celltype}{
+    Currently, only data for IPC-81, C6, NB4, HeLa, Jurkat and U937 are supported.
+    Default is "\%", i.e. any cell type.}
+  \item{enzymetype}{
+    Currently, only data for AChE, GR and GST are supported.}
+  \item{whereClause}{
+    With this argument, additional conditions for the SQL query can be set, 
+    e.g. "where plate != 710". The default is 1 (in SQL syntax this means TRUE).}
+  \item{ok}{
+    With the default value "\%", all data in the database is retrieved for the 
+    specified substance.}
+}
+\value{
+  The function lists a report and shows one graph.
+}
+\examples{
+# Check substance IM14 BF4 in the cytotox database
+\dontrun{checksubstance("IM14 BF4")}
+}
+\author{
+  Johannes Ranke 
+  \email{jranke@uni-bremen.de} 
+  \url{http://www.uft.uni-bremen.de/chemie/ranke}
+}
+\keyword{database}
diff --git a/man/linearlogisf.Rd b/man/linearlogisf.Rd
new file mode 100644
index 0000000..d49dc9a
--- /dev/null
+++ b/man/linearlogisf.Rd
@@ -0,0 +1,36 @@
+\name{linearlogisf}
+\alias{linearlogisf}
+\title{Linear-logistic function}
+\description{
+  Helper function describing a special type of dose-response curves, showing a stimulus
+  at subtoxic doses.
+}
+\usage{
+  linearlogisf(x,k,f,mu,b)
+}
+\arguments{
+  \item{x}{
+    In this context, the x variable is the dose.}
+  \item{k}{
+    In the drfit functions, k is set to 1.}
+  \item{f}{
+    One of the parameters describing the curve shape.}
+  \item{mu}{
+    The parameter describing the location of the curve (log EC50).}
+  \item{b}{
+    One of the parameters describing the curve shape.}
+}
+\value{
+  The response at dose x.
+} 
+\examples{
+  
+}
+\author{
+  Johannes Ranke 
+  \email{jranke@uni-bremen.de} 
+  \url{http://www.uft.uni-bremen.de/chemie/ranke}
+}
+\keyword{models}
+\keyword{regression}
+\keyword{nonlinear}