aboutsummaryrefslogtreecommitdiff
path: root/man/checksubstance.Rd
blob: 2e4d62d950a4f45952733ab9905c1c4b1cff42cc (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
\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 = c("cytotox", "enzymes", "ecotox"), 
    experimentator = "\%",
    celltype = "\%", enzymetype = "\%", organism = "\%",
    endpoint = "\%",
    whereClause = "1", ok = "\%")
}
\arguments{
  \item{substance}{
    The name of the substance identifying it within the database. Matching is not 
    case-sensitive.}
  \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. data for any cell type will be
    displayed.}
  \item{enzymetype}{
    Currently, only data for AChE, GR and GST are supported. The default value
    is "\%", i.e. data for any enzyme type will be displayed.}
  \item{organism}{
    The latin name of the tested organism, if the ecotox db was selected. The
    default value is "\%", i.e. data for any organism will be displayed.}
  \item{endpoint}{
    The endpoint that should be used for selecting the data. Only important if
    the database "ecotox" is used. Defaults to "\%".}
  \item{whereClause}{
    With this argument, additional conditions for the SQL query can be set,
    e.g. "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}
}
\keyword{database}
\keyword{internal}

Contact - Imprint