aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/checkexperiment.html
blob: 7acd323810e4a16edd0d6c77a5baf0dcb29e2894 (plain) (tree)
1
2
3
4
5
6
7
8
9
10

                                                  
                






                                                                                                           
 
               
                                                                                                                                                                                 

                  


                                                                                                                                                                                                             

                           

                                                                                                                                                                                                       
 
                     
                                                                                                                                                                                          
 


                                                                                                                                                                                            
 

                                             
                                     


 
 
                                                                                                                         


                                                                                                               


 
 
                

                                                                                                                                                                                                    






                                                                               
 







                                                                            

                                                                                                                               



                                      

                                                             
                                                                                                                                     
             
          
 


                                                      
                          
                                                  



      


                                                 


                                              
      




                                
 

               
                 


                                                                           

                                                                  

          
                                 

                                                                             
          
 



                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                               
















                                                                                               





                                                                                    
            
 


                                                                                   

                                                                                            




                                                                                                                                                                                                                                                   




                                                         
                                         



                                               

                                                                    


        
 





                                     
                                                                                




               

  
 

         
 
 
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <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>Check raw data from a specified experiment or microtiter plate — checkexperiment • drfit</title>


<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>

<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>

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




<meta property="og:title" content="Check raw data from a specified experiment or microtiter plate — checkexperiment" />
<meta property="og:description" content="Report metadata from a specified experiment or microtiter plate from a
  specified database, box plot controls, and plot the dose-response data." />
<meta name="twitter:card" content="summary" />




<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></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" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <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="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.7.3</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fas fa fas 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>Check raw data from a specified experiment or microtiter plate</h1>
    
    <div class="hidden name"><code>checkexperiment.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>Report metadata from a specified experiment or microtiter plate from a
  specified database, box plot controls, and plot the dose-response data.</p>
    </div>

    <pre class="usage"><span class='fu'>checkplate</span>(<span class='no'>id</span>, <span class='kw'>db</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"cytotox"</span>, <span class='st'>"enzymes"</span>))
  <span class='fu'>checkexperiment</span>(<span class='no'>id</span>, <span class='kw'>db</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"ecotox"</span>, <span class='st'>"cytotox"</span>, <span class='st'>"enzymes"</span>), <span class='kw'>endpoint</span> <span class='kw'>=</span> <span class='st'>"%"</span>,
                  <span class='kw'>whereClause</span> <span class='kw'>=</span> <span class='st'>"1"</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>id</th>
      <td><p>The id of the experiment or the plate identifying it within the database.</p></td>
    </tr>
    <tr>
      <th>db</th>
      <td><p>The database to be used. Currently, the microtiter plate databases
    "cytotox", "enzymes" of the UFT Department of Bioorganic Chemistry are
    supported, as well as the database of ecotoxicity experiments "ecotox".</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 "%".</p></td>
    </tr>
    <tr>
      <th>whereClause</th>
      <td><p>With this argument, additional conditions for the SQL query can be set,
    e.g. "duration = 48" (i.e. "Only retrieve data with duration 48"). The
    default is 1 (in SQL syntax this means TRUE).</p></td>
    </tr>
    </table>

    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>The function lists a report and shows two graphs.</p>

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'><span class='co'># Check plate number 3 in the cytotox database</span>
<span class='kw'>if</span> (<span class='fl'>FALSE</span>) <span class='fu'>checkplate</span>(<span class='fl'>3</span>)

<span class='co'># Check data from experiment 1517 with duration 48 hours</span>
<span class='kw'>if</span> (<span class='fl'>FALSE</span>) <span class='fu'>checkexperiment</span>(<span class='fl'>1517</span>, <span class='kw'>whereClause</span> <span class='kw'>=</span> <span class='st'>"duration = 48"</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="#examples">Examples</a></li>
    </ul>

    <h2>Author</h2>
    <p>Johannes Ranke
  <a href='mailto:jranke@uni-bremen.de'>jranke@uni-bremen.de</a></p>
  </div>
</div>


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

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

      </footer>
   </div>

  


  </body>
</html>


Contact - Imprint