aboutsummaryrefslogtreecommitdiff
path: root/man/drdata.Rd
blob: 2bb0b4d8dfe56195b7249b8b68721bc469b1317e (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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
\name{drdata}
\alias{drdata}
\title{Get dose-response data via RODBC}
\description{
  Get dose-response data from an adequate ODBC data source
}
\usage{
  drdata(substances, experimentator = "\%", db = "cytotox", celltype = "IPC-81",
    enzymetype="AChE", organism="Vibrio fischeri", endpoint="Luminescence",
    whereClause = "1", ok = "'ok','no fit'")
}
\arguments{
  \item{substances}{
    A string or an array of strings with the substance names for
    which dose-response data is to be retrieved. Matching is case-sensitive.}
  \item{experimentator}{
    The name of the experimentator whose data is to be used. Default is "%",
    which means that data from all experimentators are retrieved.}
  \item{db}{
    The database to be used. Currently, the databases "cytotox", "enzymes"
    and "ecotox" of the UFT Department of Bioorganic Chemistry are
    supported (default is "cytotox").}
  \item{celltype}{
    Currently, only data for IPC-81, C6, NB4, HeLa, Jurkat and U937 are
    supported.}
  \item{enzymetype}{
    Currently, only data for AChE, GR and GST are supported.}
  \item{organism}{
    The organism that was exposed to the chemical. Only important if the database
    "ecotox" is used. Defaults to "Vibrio fischeri".}
  \item{endpoint}{
    The endpoint that should be used for selecting the data. Only important if
    the database "ecotox" is used. Defaults to "Luminescence".}
  \item{whereClause}{
    With this argument, additional conditions for the SQL query can be set,
    e.g. "plate != 710" (i.e. "Do not retrieve data for plate 710"). The
    default is 1 (in SQL syntax this means TRUE).}
  \item{ok}{
    With the default value "'ok','no fit'", only data that has been checked and
    set to "ok" or "no fit" in the database is retrieved. The argument "no fit"
    will result in not using the data for fitting, but it will be plotted.
    Another sensible argument would be "'ok','no fit','?'", in order to
    additionally retrieve data which has not yet been checked.}
}
\value{
  \item{data}{
    A data frame with a factor describing the dose levels, the numeric dose
    levels and a numeric column describing the response, as well as the entries
    for plate, experimentator, performed (date of test performance), celltype,
    unit (of the dose/concentration), and for the ok field in the database.}
}
\details{
  The function is currently only used for retrieving data from the
  mysql database "cytotox" of the UFT Department of Bioorganic Chemistry.
  Access to this database is limited to UFT staff.  Additionally to the
  installation of the RODBC package, it is required to set up a ODBC data
  source with the name "cytotox", using an ODBC driver for mysql, probably
  myODBC. Then, under Unix, you can use iodbc or unixodbc for setting up the
  respective data source with data source name (DSN) "cytotox". For my
  setting using unixodbc, I am using the file \file{/etc/odbcinst.ini}
  containing:
  \tabular{lll}{
    [MySQL] \tab \tab \cr
    Description \tab = \tab MySQL driver for ODBC \cr
    Driver \tab = \tab /usr/local/lib/libmyodbc.so \cr
    Setup \tab = \tab /usr/lib/odbc/libodbcmyS.so \cr
  }
  and the file \file{/etc/odbc.ini} containing:
  \tabular{lll}{
    [cytotox] \tab \tab \cr
    Description \tab = \tab Cytotoxicity database of the department of bioorganic chemistry, UFT Bremen \cr
    Driver \tab = \tab MySQL \cr
    Trace \tab = \tab Yes  \cr
    TraceFile \tab = \tab /tmp/odbc.log  \cr
    Database \tab = \tab cytotox  \cr
    Server \tab = \tab eckehaat  \cr
    Port \tab = \tab 3306  \cr
  }
}
\examples{
# Get cytotoxicity data for Tributyltin and zinc pyrithione, tested with IPC-81
# cells
\dontrun{drdata(c("TBT","ZnPT2"))}
}
\author{
  Johannes Ranke
  \email{jranke@uni-bremen.de}
  \url{http://www.uft.uni-bremen.de/chemie/ranke}
}
\keyword{IO}
\keyword{database}

Contact - Imprint