docs/reference/JuliaCall.html

<!-- 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>JuliaCall: Seamless Integration Between R and Julia. — JuliaCall • JuliaCall</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/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" 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>


<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../jquery.sticky-kit.min.js"></script>
<script src="../pkgdown.js"></script>
<meta property="og:title" content="JuliaCall: Seamless Integration Between R and Julia. — JuliaCall" />

<meta property="og:description" content="JuliaCall provides you with functions to call Julia functions and
to use Julia packages as easy as possible." />
<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">JuliaCall</a>
        <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.13.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="../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/JuliaCall_in_Jupyter_R_Notebook.html">JuliaCall in Jupyter R Notebook</a>
    </li>
    <li>
      <a href="../articles/Julia_in_RMarkdown.html">Julia in RMarkdown</a>
    </li>
    <li>
      <a href="../articles/mandelbrot.html">Improve R's Performance using JuliaCall with Mandel Set Example</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/Non-Contradiction/JuliaCall">
    <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>JuliaCall: Seamless Integration Between R and Julia.</h1>
    <small class="dont-index">Source: <a href='https://github.com/Non-Contradiction/JuliaCall/blob/master/R/JuliaCall.R'><code>R/JuliaCall.R</code></a></small>
    <div class="hidden name"><code>JuliaCall.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <p>JuliaCall provides you with functions to call Julia functions and
to use Julia packages as easy as possible.</p>
    
    </div>

        
    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'>
</div><div class='input'> <span class='co'>## The examples are quite time consuming</span>

  <span class='co'>## Do initiation for JuliaCall</span>

  <span class='no'>julia</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='julia_setup.html'>julia_setup</a></span>()</div><div class='output co'>#&gt; <span class='message'>Julia version 0.6.2 at location /Applications/Julia-0.6.app/Contents/Resources/julia/bin will be used.</span></div><div class='output co'>#&gt; <span class='message'>Julia initiation...</span></div><div class='output co'>#&gt; <span class='message'>Finish Julia initiation.</span></div><div class='output co'>#&gt; <span class='message'>Loading setup script for JuliaCall...</span></div><div class='output co'>#&gt; <span class='message'>Finish loading setup script for JuliaCall.</span></div><div class='input'>
  <span class='co'>## Different ways for calculating `sqrt(2)`</span>

  <span class='co'># julia$command("a = sqrt(2)"); julia$eval("a")</span>
  <span class='fu'><a href='julia_command.html'>julia_command</a></span>(<span class='st'>"a = sqrt(2)"</span>); <span class='fu'><a href='julia_eval.html'>julia_eval</a></span>(<span class='st'>"a"</span>)</div><div class='output co'>#&gt; [1] 1.414214</div><div class='input'>
  <span class='co'># julia$eval("sqrt(2)")</span>
  <span class='fu'><a href='julia_eval.html'>julia_eval</a></span>(<span class='st'>"sqrt(2)"</span>)</div><div class='output co'>#&gt; [1] 1.414214</div><div class='input'>
  <span class='co'># julia$call("sqrt", 2)</span>
  <span class='fu'><a href='call.html'>julia_call</a></span>(<span class='st'>"sqrt"</span>, <span class='fl'>2</span>)</div><div class='output co'>#&gt; [1] 1.414214</div><div class='input'>
  <span class='co'># julia$eval("sqrt")(2)</span>
  <span class='fu'><a href='julia_eval.html'>julia_eval</a></span>(<span class='st'>"sqrt"</span>)(<span class='fl'>2</span>)</div><div class='output co'>#&gt; [1] 1.414214</div><div class='input'>
  <span class='co'>## You can use `julia_exists` as `exists` in R to test</span>
  <span class='co'>## whether a function or name exists in Julia or not</span>

  <span class='co'># julia$exists("sqrt")</span>
  <span class='fu'><a href='julia_exists.html'>julia_exists</a></span>(<span class='st'>"sqrt"</span>)</div><div class='output co'>#&gt; [1] TRUE</div><div class='input'>
  <span class='co'>## You can use `julia$help` to get help for Julia functions</span>

  <span class='co'># julia$help("sqrt")</span>
  <span class='fu'><a href='julia_help.html'>julia_help</a></span>(<span class='st'>"sqrt"</span>)</div><div class='output co'>#&gt; ```
#&gt; sqrt(x)
#&gt; ```
#&gt; 
#&gt; Return $\sqrt{x}$. Throws [`DomainError`](@ref) for negative [`Real`](@ref) arguments. Use complex negative arguments instead. The prefix operator `√` is equivalent to `sqrt`.</div><div class='input'>
  <span class='co'>## You can install and use Julia packages through JuliaCall</span>

  <span class='co'># julia$install_package("Optim")</span>
  <span class='fu'><a href='julia_package.html'>julia_install_package</a></span>(<span class='st'>"Optim"</span>)

  <span class='co'># julia$install_package_if_needed("Optim")</span>
  <span class='fu'><a href='julia_package.html'>julia_install_package_if_needed</a></span>(<span class='st'>"Optim"</span>)

  <span class='co'># julia$installed_package("Optim")</span>
  <span class='fu'><a href='julia_package.html'>julia_installed_package</a></span>(<span class='st'>"Optim"</span>)</div><div class='output co'>#&gt; [1] "0.14.1"</div><div class='input'>
  <span class='co'># julia$library("Optim")</span>
  <span class='fu'><a href='julia_package.html'>julia_library</a></span>(<span class='st'>"Optim"</span>)</div><div class='input'>
</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="#examples">Examples</a></li>
    </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Changcheng Li.</p>
</div>

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

      </footer>
   </div>

  
  </body>
</html>