<!-- 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>Optains a session info from R executed in a container — extract_session_image • containerit</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/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" 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>

<!-- 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="Optains a session info from R executed in a container — extract_session_image" />

<meta property="og:description" content="The function uses the given Docker image and executes the given expressions.
To access the session information, a directory is mounted from the host into the container, to which the R session in the container saves an RData file with the sessionInfo object." />

<meta property="og:image" content="/logo.png" />
<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">containerit</a>
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.0</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="../articles/containerit.html">Get started</a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="../articles/basic.html">Basic introduction to package containerit</a>
    </li>
    <li>
      <a href="../articles/bioconductor.html">Using Bioconductor with containerit</a>
    </li>
    <li>
      <a href="../articles/container.html">Using the containerit Docker image</a>
    </li>
  </ul>
</li>
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        <li>
  <a href="https://github.com/o2r-project/containerit">
    <span class="fa fa-github fa-lg"></span>
     
  </a>
</li>
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      
      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
    <h1>Optains a session info from R executed in a container</h1>
    <small class="dont-index">Source: <a href='https://github.com/o2r-project/containerit/blob/master/R/utility-functions.R'><code>R/utility-functions.R</code></a></small>
    <div class="hidden name"><code>extract_session_image.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>The function uses the given Docker image and executes the given expressions.
To access the session information, a directory is mounted from the host into the container, to which the R session in the container saves an RData file with the sessionInfo object.</p>
    
    </div>

    <pre class="usage"><span class='fu'>extract_session_image</span>(<span class='no'>docker_image</span>, <span class='kw'>expr</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(), <span class='kw'>container_dir</span> <span class='kw'>=</span> <span class='st'>"/tmp"</span>,
  <span class='kw'>local_dir</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/tempfile'>tempfile</a></span>(<span class='kw'>pattern</span> <span class='kw'>=</span> <span class='st'>"extract_bind_"</span>),
  <span class='kw'>deleteTempfiles</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>container_name</span> <span class='kw'>=</span> <span class='st'>"containerit_capturer"</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>docker_image</th>
      <td><p>The name of the Docker image to run</p></td>
    </tr>
    <tr>
      <th>expr</th>
      <td><p>A list of expressions to be executed in the session</p></td>
    </tr>
    <tr>
      <th>container_dir</th>
      <td><p>The directory in the container where a local temp directory is mounted to, for saving the session info to a file (in lack of a COPY instruction)</p></td>
    </tr>
    <tr>
      <th>local_dir</th>
      <td><p>The local directory mounted into the container</p></td>
    </tr>
    <tr>
      <th>deleteTempfiles</th>
      <td><p>Remove used <code>local_dir</code> directory when done</p></td>
    </tr>
    <tr>
      <th>container_name</th>
      <td><p>The name used to run the container (which will be removed at the end)</p></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>An object of class session info</p>
    
    <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2>

    <p>This function was created for test purposes in order to compare sessionInfos.</p>
    

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'><span class='fu'>extract_session_image</span>(<span class='st'>"rocker/geospatial:3.3.3"</span>)</div><div class='output co'>#&gt; INFO [2019-08-20 16:44:02] Running R in container to obtain a session info using image rocker/geospatial:3.3.3 and command R --vanilla -e info &lt;- sessionInfo() -e save(list = "info", file = "/tmp/capture.RData")</div><div class='output co'>#&gt; <span class='message'>Detected API version '1.40' is above max version '1.39'; downgrading</span></div><div class='output co'>#&gt; O&gt; 
#&gt; O&gt; R version 3.3.3 (2017-03-06) -- "Another Canoe"
#&gt; O&gt; Copyright (C) 2017 The R Foundation for Statistical Computing
#&gt; O&gt; Platform: x86_64-pc-linux-gnu (64-bit)
#&gt; O&gt; 
#&gt; O&gt; R is free software and comes with ABSOLUTELY NO WARRANTY.
#&gt; O&gt; You are welcome to redistribute it under certain conditions.
#&gt; O&gt; Type 'license()' or 'licence()' for distribution details.
#&gt; O&gt; 
#&gt; O&gt; R is a collaborative project with many contributors.
#&gt; O&gt; Type 'contributors()' for more information and
#&gt; O&gt; 'citation()' on how to cite R or R packages in publications.
#&gt; O&gt; 
#&gt; O&gt; Type 'demo()' for some demos, 'help()' for on-line help, or
#&gt; O&gt; 'help.start()' for an HTML browser interface to help.
#&gt; O&gt; Type 'q()' to quit R.
#&gt; O&gt; 
#&gt; O&gt; &gt; info &lt;- sessionInfo()
#&gt; O&gt; &gt; save(list = "info", file = "/tmp/capture.RData")
#&gt; O&gt; &gt; 
#&gt; O&gt; &gt; 
#&gt; INFO [2019-08-20 16:44:04] Wrote sessioninfo from Docker to /tmp/RtmpaH9WJK/extract_bind_5e4a3b385408/capture.RData</div><div class='output co'>#&gt; R version 3.3.3 (2017-03-06)
#&gt; Platform: x86_64-pc-linux-gnu (64-bit)
#&gt; Running under: Debian GNU/Linux 8 (jessie)
#&gt; 
#&gt; Matrix products: 
#&gt; 
#&gt; Random number generation:
#&gt;  RNG:     
#&gt;  Normal:  
#&gt;  Sample:  
#&gt;  
#&gt; locale:
#&gt;  [1] LC_CTYPE=en_US.UTF-8       LC_NUMERIC=C              
#&gt;  [3] LC_TIME=en_US.UTF-8        LC_COLLATE=en_US.UTF-8    
#&gt;  [5] LC_MONETARY=en_US.UTF-8    LC_MESSAGES=C             
#&gt;  [7] LC_PAPER=en_US.UTF-8       LC_NAME=C                 
#&gt;  [9] LC_ADDRESS=C               LC_TELEPHONE=C            
#&gt; [11] LC_MEASUREMENT=en_US.UTF-8 LC_IDENTIFICATION=C       
#&gt; 
#&gt; attached base packages:
#&gt; [1] stats     graphics  grDevices utils     datasets  methods   base     </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="#note">Note</a></li>
      
      <li><a href="#examples">Examples</a></li>
    </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Daniel Nuest, Matthias Hinz.</p>
</div>

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

  

  </body>
</html>

