aboutsummaryrefslogtreecommitdiff
path: root/docs/index.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2018-09-13 23:46:59 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2018-09-13 23:46:59 +0200
commit062df4d773cd4e57c862054fe9b5232b5a055c34 (patch)
tree4d895963ebb54f103f6d3db65328a6de9b5c6932 /docs/index.html
parentfcba8a833c5f920b12e1d7f17ef2d5236a81b354 (diff)
Require mkin version that actually works with gmkin
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/index.html')
-rw-r--r--docs/index.html30
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/index.html b/docs/index.html
index a654b22..0df4c29 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -31,7 +31,7 @@
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">gmkin</a>
- <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.6.8</span>
+ <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.6.9</span>
</span>
</div>
@@ -93,14 +93,14 @@
<h3 class="hasAnchor">
<a href="#installing-gmkin-and-gwidgetswww2" class="anchor"></a>Installing gmkin and gWidgetsWWW2</h3>
<p>Windows and Linux users running R 3.1.0 or later can make use of my drat package repository on github. Before installing gmkin, you should update your R packages already installed, e.g. by starting R, and pasting the command</p>
-<div class="sourceCode"><pre class="sourceCode s"><code class="sourceCode gnuassembler">update.packages()</code></pre></div>
+<div class="sourceCode" id="cb1"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><a class="sourceLine" id="cb1-1" data-line-number="1">update.packages()</a></code></pre></div>
<p>or similar, depending on your R installation.</p>
<p>For installing gmkin or upgrading to the latest released version, please install the drat package</p>
-<div class="sourceCode"><pre class="sourceCode s"><code class="sourceCode gnuassembler">install.packages(<span class="st">"drat"</span>)</code></pre></div>
+<div class="sourceCode" id="cb2"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><a class="sourceLine" id="cb2-1" data-line-number="1">install.packages(<span class="st">"drat"</span>)</a></code></pre></div>
<p>add my repository</p>
-<div class="sourceCode"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><span class="kw">drat::</span>addRepo(<span class="st">"jranke"</span>)</code></pre></div>
+<div class="sourceCode" id="cb3"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><a class="sourceLine" id="cb3-1" data-line-number="1"><span class="kw">drat::</span>addRepo(<span class="st">"jranke"</span>)</a></code></pre></div>
<p>and install as usual</p>
-<div class="sourceCode"><pre class="sourceCode s"><code class="sourceCode gnuassembler">install.packages(<span class="st">"gmkin"</span>)</code></pre></div>
+<div class="sourceCode" id="cb4"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><a class="sourceLine" id="cb4-1" data-line-number="1">install.packages(<span class="st">"gmkin"</span>)</a></code></pre></div>
<p>The latest changes to gmkin are recorded in the <a href="https://github.com/jranke/gmkin/blob/master/NEWS.html">NEWS</a> file, more details can be found in the <a href="https://github.com/jranke/gmkin/commits/master">commit history</a>.</p>
<p><img src="gmkin_screenshot.png" alt="gmkin screenshot"></p>
</div>
@@ -109,8 +109,8 @@
<h2 class="hasAnchor">
<a href="#usage" class="anchor"></a>Usage</h2>
<p>Without further preparation, you can start the GUI by starting R and pasting the following commands into the R terminal (R console on Windows):</p>
-<div class="sourceCode"><pre class="sourceCode s"><code class="sourceCode gnuassembler">require(gmkin)
-gmkin()</code></pre></div>
+<div class="sourceCode" id="cb5"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><a class="sourceLine" id="cb5-1" data-line-number="1">require(gmkin)</a>
+<a class="sourceLine" id="cb5-2" data-line-number="2">gmkin()</a></code></pre></div>
<p>You may also want to adapt the browser that R starts (using e.g. <code>options(browser="/usr/bin/firefox")</code> on linux, or setting the default browser on Windows).</p>
</div>
<div id="documentation" class="section level2">
@@ -137,9 +137,9 @@ gmkin()</code></pre></div>
<h3 class="hasAnchor">
<a href="#installation-using-the-devtools-package" class="anchor"></a>Installation using the devtools package</h3>
<p>Users of the <code>devtools</code> package can also install gWidgetsWWW2 and gmkin directly from the respective github repositories:</p>
-<div class="sourceCode"><pre class="sourceCode s"><code class="sourceCode gnuassembler">require(devtools)
-install_github(<span class="st">"jverzani/gWidgetsWWW2"</span>, quick = TRUE)
-install_github(<span class="st">"jranke/gmkin"</span>, quick = TRUE)</code></pre></div>
+<div class="sourceCode" id="cb6"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><a class="sourceLine" id="cb6-1" data-line-number="1">require(devtools)</a>
+<a class="sourceLine" id="cb6-2" data-line-number="2">install_github(<span class="st">"jverzani/gWidgetsWWW2"</span>, quick = TRUE)</a>
+<a class="sourceLine" id="cb6-3" data-line-number="3">install_github(<span class="st">"jranke/gmkin"</span>, quick = TRUE)</a></code></pre></div>
<p>Installing gWidgetsWWW2 in this way yields a lot of warnings concerning overly long path names (see Notes on gWidgetsWWW2 above). Using <code>quick = TRUE</code> skips docs, multiple-architecture builds, demos, and vignettes, to make installation as fast and painless as possible.</p>
</div>
</div>
@@ -147,11 +147,11 @@ install_github(<span class="st">"jranke/gmkin"</span>, quick = TRUE)</code></pre
<h2 class="hasAnchor">
<a href="#simplifying-the-start-of-gmkin-under-windows" class="anchor"></a>Simplifying the start of gmkin under Windows</h2>
<p>You can put the commands</p>
-<div class="sourceCode"><pre class="sourceCode s"><code class="sourceCode gnuassembler">require(gmkin)
-gmkin()
-while (TRUE) {
- Sys.sleep(<span class="dv">10</span>)
-}</code></pre></div>
+<div class="sourceCode" id="cb7"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><a class="sourceLine" id="cb7-1" data-line-number="1">require(gmkin)</a>
+<a class="sourceLine" id="cb7-2" data-line-number="2">gmkin()</a>
+<a class="sourceLine" id="cb7-3" data-line-number="3">while (TRUE) {</a>
+<a class="sourceLine" id="cb7-4" data-line-number="4"> Sys.sleep(<span class="dv">10</span>)</a>
+<a class="sourceLine" id="cb7-5" data-line-number="5">}</a></code></pre></div>
<p>into an R script (e.g. under <code>C:\Users\&lt;your username&gt;\AppData\Roaming\gmkin_start.R</code>), and create a Windows shortcut, e.g. on the Desktop, with the target <code>"C:\Program Files\R\R-3.x.y\bin\R.exe" --slave -f c:\Users\&lt;your username&gt;\AppData\Roaming\gmkin_start.R</code>, where R.x.y is the version of R that you would like to use with gmkin. This will start a non-interactive R console that runs the gmkin GUI. In the properties dialogue of the shortcut, you can also set the working directory in which it starts gmkin. Thanks to Jonas Klein of the Umweltbundesamt for the trick with using Sys.sleep in a while loop and for suggesting the AppData directory for the start script.</p>
</div>
<div id="acknowledgements" class="section level2">

Contact - Imprint