diff options
Diffstat (limited to 'docs/reference/drdata.html')
-rw-r--r-- | docs/reference/drdata.html | 245 |
1 files changed, 245 insertions, 0 deletions
diff --git a/docs/reference/drdata.html b/docs/reference/drdata.html new file mode 100644 index 0000000..e369c5c --- /dev/null +++ b/docs/reference/drdata.html @@ -0,0 +1,245 @@ +<!-- 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"> + + +<!-- pkgdown --> +<link href="../pkgdown.css" rel="stylesheet"> +<script src="../jquery.sticky-kit.min.js"></script> +<script src="../pkgdown.js"></script> + +<!-- mathjax --> +<script src='https://cdn.mathjax.org/mathjax/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> + <a class="navbar-brand" href="../index.html">drfit</a> + </div> + <div id="navbar" class="navbar-collapse collapse"> + <ul class="nav navbar-nav"> + <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> + + + <p>Get dose-response data from an adequate ODBC data source</p> + + + <pre><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.</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><tr><td> + [MySQL] </td> +<td> </td> +</tr><tr><td> </td> +<td> + Description </td> +</tr><tr><td> = </td> +<td> MySQL driver for ODBC </td> +</tr><tr><td> + Driver </td> +<td> = </td> +</tr><tr><td> /usr/local/lib/libmyodbc.so </td> +<td> + Setup </td> +</tr><tr><td> = </td> +<td> /usr/lib/odbc/libodbcmyS.so </td> +</tr></table><p>and the file <code class="file">/etc/odbc.ini</code> containing:</p><table><tr><td> + [cytotox] </td> +<td> </td> +</tr><tr><td> </td> +<td> + Description </td> +</tr><tr><td> = </td> +<td> Cytotoxicity database of the department of bioorganic chemistry, UFT Bremen </td> +</tr><tr><td> + Driver </td> +<td> = </td> +</tr><tr><td> MySQL </td> +<td> + Trace </td> +</tr><tr><td> = </td> +<td> Yes </td> +</tr><tr><td> + TraceFile </td> +<td> = </td> +</tr><tr><td> /tmp/odbc.log </td> +<td> + Database </td> +</tr><tr><td> = </td> +<td> cytotox </td> +</tr><tr><td> + Server </td> +<td> = </td> +</tr><tr><td> eckehaat </td> +<td> + Port </td> +</tr><tr><td> = </td> +<td> 3306 </td> +</tr></table> + + + <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> + <pre class="examples"><div class='input'><span class='co'># Get cytotoxicity data for Tributyltin and zinc pyrithione, tested with IPC-81</span> +<span class='co'># cells</span> +<span class='co'>## Not run: drdata(c("TBT","ZnPT2"))</span></div></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://hadley.github.io/pkgdown/">pkgdown</a>.</p> +</div> + + </footer> + </div> + + </body> +</html> |