aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/gmkin.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-03-06 15:39:58 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-03-06 15:39:58 +0100
commit71468046acbaf005173ababa0fe5ffb9c6426278 (patch)
tree4de91ca97bb0f8a80264c7f26f0d48d8505bf1c0 /docs/reference/gmkin.html
parentac655f0c05b184ddffe64b3b37d1682998dfd5cc (diff)
Static documentation built by pkgdownv0.6.8
Not by staticdocs any more
Diffstat (limited to 'docs/reference/gmkin.html')
-rw-r--r--docs/reference/gmkin.html158
1 files changed, 158 insertions, 0 deletions
diff --git a/docs/reference/gmkin.html b/docs/reference/gmkin.html
new file mode 100644
index 0000000..da80908
--- /dev/null
+++ b/docs/reference/gmkin.html
@@ -0,0 +1,158 @@
+<!-- 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>
+ — 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">
+
+
+<!-- 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">gmkin</a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="../reference/index.html">Reference</a>
+</li>
+<li>
+ <a href="../articles/index.html">Articles</a>
+</li>
+<li>
+ <a href="../news/index.html">News</a>
+</li>
+ </ul>
+
+ <ul class="nav navbar-nav navbar-right">
+ <li>
+ <a href="http://github.com/jranke/gmkin">
+ <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>
+</h1>
+ </div>
+
+
+ <p>This function starts a browser based GUI. Please visit the
+ <a href = 'github page of gWidgetsWWW2'>http://github.com/jverzani/gWidgetsWWW2</a>
+ for an explanation how this toolkit works.</p>
+
+
+ <pre><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>
+ <dl class="dl-horizontal">
+ <dt>script_name</dt>
+ <dd>
+ 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.
+ </dd>
+ <dt>show.log</dt>
+ <dd>
+ During development, it may be useful to see the log of the Rook apps.
+ </dd>
+ </dl>
+
+ <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'> <span class='co'>## Not run: gmkin() # Start the gmkin GUI</span>
+ <span class='co'>## Not run: ------------------------------------</span>
+<span class='co'># g &lt;- gmkin()</span>
+<span class='co'># </span>
+<span class='co'># # Only for debugging or other advanced usage:</span>
+<span class='co'># session &lt;- gmkin:::get_current_session(g)</span>
+<span class='co'># session$p.df</span>
+<span class='co'># session$ds.df</span>
+<span class='co'># session$ds.cur</span>
+<span class='co'># session$m.cur</span>
+<span class='co'># session$ws</span>
+<span class='co'># </span>
+<span class='co'>## --------------------------------------------- </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>
+
+ 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://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+</div>
+
+ </footer>
+ </div>
+
+ </body>
+</html>

Contact - Imprint