aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/drdata.html
blob: fc962bea43f867d7232e3ad08ddf499dabd26b67 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
  <head>
  <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Get dose-response data via RODBC — drdata • drfit</title>

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>



<meta property="og:title" content="Get dose-response data via RODBC — drdata" />

<meta property="og:description" content="Get dose-response data from an adequate ODBC data source" />
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->


  </head>

  <body>
    <div class="container template-reference-topic">
      <header>
      <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">drfit</a>
        <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.7.1</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      
      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Get dose-response data via RODBC</h1>
    
    <div class="hidden name"><code>drdata.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>Get dose-response data from an adequate ODBC data source</p>
    
    </div>

    <pre class="usage"><span class='fu'>drdata</span>(<span class='no'>substances</span>, <span class='kw'>experimentator</span> <span class='kw'>=</span> <span class='st'>"%"</span>, <span class='kw'>db</span> <span class='kw'>=</span> <span class='st'>"cytotox"</span>, <span class='kw'>celltype</span> <span class='kw'>=</span> <span class='st'>"IPC-81"</span>,
    <span class='kw'>enzymetype</span><span class='kw'>=</span><span class='st'>"AChE"</span>, <span class='kw'>organism</span><span class='kw'>=</span><span class='st'>"Vibrio fischeri"</span>, <span class='kw'>endpoint</span><span class='kw'>=</span><span class='st'>"Luminescence"</span>,
    <span class='kw'>whereClause</span> <span class='kw'>=</span> <span class='st'>"1"</span>, <span class='kw'>ok</span> <span class='kw'>=</span> <span class='st'>"'ok','no fit'"</span>)</pre>
    
    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>substances</th>
      <td><p>A string or an array of strings with the substance names for
    which dose-response data is to be retrieved. Matching is case-sensitive.</p></td>
    </tr>
    <tr>
      <th>experimentator</th>
      <td><p>The name of the experimentator whose data is to be used. Default is "<!-- %", -->
    which means that data from all experimentators are retrieved.</p></td>
    </tr>
    <tr>
      <th>db</th>
      <td><p>The database to be used. Currently, the databases "cytotox", "enzymes"
    and "ecotox" of the UFT Department of Bioorganic Chemistry are
    supported (default is "cytotox").</p></td>
    </tr>
    <tr>
      <th>celltype</th>
      <td><p>Currently, only data for IPC-81, C6, NB4, HeLa, Jurkat and U937 are
    supported.</p></td>
    </tr>
    <tr>
      <th>enzymetype</th>
      <td><p>Currently, only data for AChE, GR and GST are supported.</p></td>
    </tr>
    <tr>
      <th>organism</th>
      <td><p>The organism that was exposed to the chemical. Only important if the database
    "ecotox" is used. Defaults to "Vibrio fischeri".</p></td>
    </tr>
    <tr>
      <th>endpoint</th>
      <td><p>The endpoint that should be used for selecting the data. Only important if
    the database "ecotox" is used. Defaults to "Luminescence".</p></td>
    </tr>
    <tr>
      <th>whereClause</th>
      <td><p>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).</p></td>
    </tr>
    <tr>
      <th>ok</th>
      <td><p>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.</p></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p></p>
<dt>data</dt><dd><p>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.</p></dd>

    
    <h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>

    <p>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 <code class="file">/etc/odbcinst.ini</code>
  containing:</p><table class='table'>
<tr><td>[MySQL]</td><td></td><td></td></tr>
<tr><td>Description</td><td>=</td><td>MySQL driver for ODBC</td></tr>
<tr><td>Driver</td><td>=</td><td>/usr/local/lib/libmyodbc.so</td></tr>
<tr><td>Setup</td><td>=</td><td>/usr/lib/odbc/libodbcmyS.so</td></tr>
<tr><td></td><td>[MySQL]</td><td></td></tr>
</table>
<p>and the file <code class="file">/etc/odbc.ini</code> containing:</p><table class='table'>
<tr><td>[cytotox]</td><td></td><td></td></tr>
<tr><td>Description</td><td>=</td><td>Cytotoxicity database of the department of bioorganic chemistry, UFT Bremen</td></tr>
<tr><td>Driver</td><td>=</td><td>MySQL</td></tr>
<tr><td>Trace</td><td>=</td><td>Yes</td></tr>
<tr><td>TraceFile</td><td>=</td><td>/tmp/odbc.log</td></tr>
<tr><td>Database</td><td>=</td><td>cytotox</td></tr>
<tr><td>Server</td><td>=</td><td>eckehaat</td></tr>
<tr><td>Port</td><td>=</td><td>3306</td></tr>
<tr><td></td><td>[cytotox]</td><td></td></tr>
</table>
    

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'># Get cytotoxicity data for Tributyltin and zinc pyrithione, tested with IPC-81
# cells
</div><span class='co'># NOT RUN {</span>
<span class='fu'>drdata</span>(<span class='fu'>c</span>(<span class='st'>"TBT"</span>,<span class='st'>"ZnPT2"</span>))
<span class='co'># }</span></pre>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
    <h2>Contents</h2>
    <ul class="nav nav-pills nav-stacked">
      <li><a href="#arguments">Arguments</a></li>
      
      <li><a href="#value">Value</a></li>

      <li><a href="#details">Details</a></li>
      
      <li><a href="#examples">Examples</a></li>
    </ul>

    <h2>Author</h2>
    
  Johannes Ranke
  <a href='mailto:jranke@uni-bremen.de'>jranke@uni-bremen.de</a>
  <a href='http://www.uft.uni-bremen.de/chemie/ranke'>http://www.uft.uni-bremen.de/chemie/ranke</a>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

      </footer>
   </div>

  

  </body>
</html>

Contact - Imprint