diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2017-10-13 09:34:15 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2017-10-13 09:34:15 +0200 |
| commit | 28425283bdeb34fac01d1eeb9c8dd40f987934ea (patch) | |
| tree | ddabdcd7a60d9ee7f6a34f604ee4cb38d7ed6dc7 /docs/reference/gmkin.html | |
| parent | e3fa7ea27ccdf98e751642dea7315ce6076ad004 (diff) | |
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/reference/gmkin.html')
| -rw-r--r-- | docs/reference/gmkin.html | 61 |
1 files changed, 31 insertions, 30 deletions
diff --git a/docs/reference/gmkin.html b/docs/reference/gmkin.html index d65deb2..961372e 100644 --- a/docs/reference/gmkin.html +++ b/docs/reference/gmkin.html @@ -6,8 +6,7 @@ <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - — gmkin • gmkin</title> +<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> @@ -26,12 +25,14 @@ <script src="../pkgdown.js"></script> <!-- mathjax --> -<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> +<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> @@ -73,31 +74,31 @@ <div class="row"> <div class="col-md-9 contents"> <div class="page-header"> - <h1> -</h1> + <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 = 'github page of gWidgetsWWW2'>http://github.com/jverzani/gWidgetsWWW2</a> + <a href = 'http://github.com/jverzani/gWidgetsWWW2'>github page of 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> + <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> - <dl class="dl-horizontal"> - <dt>script_name</dt> - <dd> - During development, a script name with a local working version + <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. - </dd> - <dt>show.log</dt> - <dd> - During development, it may be useful to see the log of the Rook apps. - </dd> - </dl> + 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> @@ -107,18 +108,18 @@ <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 <- gmkin()</span> -<span class='co'># </span> -<span class='co'># # Only for debugging or other advanced usage:</span> -<span class='co'># session <- 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> + <span class='fu'>not_run</span>({ + <span class='no'>g</span> <span class='kw'><-</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'><-</span> <span class='kw'>gmkin</span><span class='kw'>:::</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> + +})</div></pre> </div> <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> <h2>Contents</h2> |