aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/gmkin.html
blob: 75548cb2021af5f101a5bf78de34b41cbb2b3897 (plain) (tree)
1
2
3
4
5
6
7
8
9







                                                                      
                                                                                                                         










                                                                                                                                                                                                                      

                                                                                                                                                                                                              




                                                   







                                                                                                                                       
                
                                                                                                  




                                                                               

 

















                                                                                                         



                                          

     












                                                                                                 






                                              
        










                                 
                                                                                                   



                                                                  
                                                                                    


                                                
                                                                                                                                                                                         

                                                                                                




                                                                           
                                                                          






                                                                                           







                                                                                                          














                                                                                                                                                                                                       























                                                         
                                                                         






               
<!-- 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>Start a graphical user interface (GUI) based on the <code>gWidgetsWWW2</code> toolkit. — gmkin • gmkin</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>

<!-- 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="Start a graphical user interface (GUI) based on the <code>gWidgetsWWW2</code> toolkit. — gmkin" />

<meta property="og:description" content="This function starts a browser based GUI. Please visit the 
  github page of gWidgetsWWW2 
  for an explanation how this toolkit works." />
<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>
      <a class="navbar-brand" href="../index.html">gmkin</a>
    </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/gmkin_manual.html">Manual for gmkin</a>
    </li>
  </ul>
</li>
<li>
  <a href="../news/index.html">News</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>Start a graphical user interface (GUI) based on the <code>gWidgetsWWW2</code> toolkit.</h1>
    </div>

    
    <p>This function starts a browser based GUI. Please visit the 
  <a href='http://github.com/jverzani/gWidgetsWWW2'>github page of gWidgetsWWW2</a> 
  for an explanation how this toolkit works.</p>
    

    <pre class="usage"><span class='fu'>gmkin</span>(<span class='no'>script_name</span>, <span class='kw'>show.log</span> <span class='kw'>=</span> <span class='fl'>FALSE</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>script_name</th>
      <td><p>During development, a script name with a local working version
    of gmkin can be passed. Defaults to the location of the gmkin.R script
    shipped with the package.</p></td>
    </tr>
    <tr>
      <th>show.log</th>
      <td><p>During development, it may be useful to see the log of the Rook apps.</p></td>
    </tr>
    </table>
    
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>The function is called for its side effect, namely starting the GUI in a browser. 
  For the curious, the desperate or the adventurous, the gmkin app (a GWidgetsApp object) is returned.</p>
    

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'>  </div><span class='co'># NOT RUN {</span>
<span class='fu'>gmkin</span>()
<span class='co'># }</span><div class='input'> # Start the gmkin GUI
  </div><span class='co'># NOT RUN {</span>
    <span class='no'>g</span> <span class='kw'>&lt;-</span> <span class='fu'>gmkin</span>()

    <span class='co'># Only for debugging or other advanced usage:</span>
    <span class='no'>session</span> <span class='kw'>&lt;-</span> <span class='kw pkg'>gmkin</span><span class='kw ns'>:::</span><span class='fu'>get_current_session</span>(<span class='no'>g</span>)
    <span class='no'>session</span>$<span class='no'>p.df</span>
    <span class='no'>session</span>$<span class='no'>ds.df</span>
    <span class='no'>session</span>$<span class='no'>ds.cur</span>
    <span class='no'>session</span>$<span class='no'>m.cur</span>
    <span class='no'>session</span>$<span class='no'>ws</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="#examples">Examples</a></li>
    </ul>

    <h2>Author</h2>
    
  Johannes Ranke

  </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