aboutsummaryrefslogtreecommitdiff
path: root/docs/index.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-10-13 09:34:15 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2017-10-13 09:34:15 +0200
commit28425283bdeb34fac01d1eeb9c8dd40f987934ea (patch)
treeddabdcd7a60d9ee7f6a34f604ee4cb38d7ed6dc7 /docs/index.html
parente3fa7ea27ccdf98e751642dea7315ce6076ad004 (diff)
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/index.html')
-rw-r--r--docs/index.html26
1 files changed, 12 insertions, 14 deletions
diff --git a/docs/index.html b/docs/index.html
index 47725c1..38efd2c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -9,7 +9,7 @@
<!-- 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="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><!-- 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]-->
@@ -51,23 +51,23 @@
<div class="contents col-md-9">
<div id="gmkin" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
-<a href="#gmkin" class="anchor"> </a>gmkin</h1></div>
+<a href="#gmkin" class="anchor"></a>gmkin</h1></div>
<div id="system-requirements" class="section level2">
<h2 class="hasAnchor">
-<a href="#system-requirements" class="anchor"> </a>System requirements</h2>
+<a href="#system-requirements" class="anchor"></a>System requirements</h2>
<p>For running gmkin you need a system running a recent version of R (version 3.1.0 or later), the gWidgesWWW2 package, the gmkin package and a web browser (Firefox/Iceweasel and Chrome work for me) with JavaScript enabled.</p>
<p>It should be possible to run gmkin on most laptop or desktop computers running Linux, Mac OS X, Windows XP or Windows 7. It is frequently checked under Linux and Windows 7.</p>
<p>To view the complete set of widgets in the browser window without resizing anything, it needs a screen space of 1366x740 pixels.</p>
<div id="installing-r" class="section level3">
<h3 class="hasAnchor">
-<a href="#installing-r" class="anchor"> </a>Installing R</h3>
+<a href="#installing-r" class="anchor"></a>Installing R</h3>
<p>Please refer to <a href="http://cran.r-project.org">CRAN</a> for installation instructions and binary packages. If you are on Windows, please consult the <a href="http://cran.r-project.org/bin/windows/base/rw-FAQ.html">FAQ for Windows</a>, especially the entries “<a href="http://cran.r-project.org/bin/windows/base/rw-FAQ.html#How-do-I-install-R-for-Windows_003f">How do I install R for Windows?</a>”, “<a href="http://cran.r-project.org/bin/windows/base/rw-FAQ.html#How-do-I-run-it_003f">How do I run it?</a>”.</p>
<p>If you would like to upgrade your R installation, please refer to the respective <a href="http://cran.r-project.org/bin/windows/base/rw-FAQ.html#What_0027s-the-best-way-to-upgrade_003f">FAQ entry</a>.</p>
</div>
<div id="installing-gmkin-and-gwidgetswww2" class="section level3">
<h3 class="hasAnchor">
-<a href="#installing-gmkin-and-gwidgetswww2" class="anchor"> </a>Installing gmkin and gWidgetsWWW2</h3>
+<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 the package repository on R-Forge. 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>
<p>or similar, depending on your R installation.</p>
@@ -82,7 +82,7 @@
</div>
<div id="usage" class="section level2">
<h2 class="hasAnchor">
-<a href="#usage" class="anchor"> </a>Usage</h2>
+<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>
@@ -90,13 +90,13 @@ gmkin()</code></pre></div>
</div>
<div id="documentation" class="section level2">
<h2 class="hasAnchor">
-<a href="#documentation" class="anchor"> </a>Documentation</h2>
+<a href="#documentation" class="anchor"></a>Documentation</h2>
<p>For a complete overview of the functionality of the gmkin graphical user interface please refer to the <a href="http://kinfit.r-forge.r-project.org/gmkin_static/vignettes/gmkin_manual.html">manual</a> available at the gmkin <a href="http://kinfit.r-forge.r-project.org/gmkin_static">documentation website</a>.</p>
<p>In case you would like to see the documentation of the underlying mkin package, please refer to its <a href="http://kinfit.r-forge.r-project.org/mkin_static">documentation website</a>.</p>
</div>
<div id="status-and-known-issues" class="section level2">
<h2 class="hasAnchor">
-<a href="#status-and-known-issues" class="anchor"> </a>Status and known issues</h2>
+<a href="#status-and-known-issues" class="anchor"></a>Status and known issues</h2>
<ul>
<li>gmkin was developed in the hope that it will be useful. However, no warranty can be given that it will meet your expectations. There may be bugs, so please be careful, check your results for plausibility and use your own expertise to judge yourself.</li>
<li>Starting the GUI takes some time. If the GUI does not come up after 10-15 seconds, close your browser and start gmkin again using the command ‘gmkin()’. Once the GUI is started, it is reasonably responsive.</li>
@@ -105,12 +105,12 @@ gmkin()</code></pre></div>
</ul>
<div id="notes-on-the-gwidgetswww2-package" class="section level3">
<h3 class="hasAnchor">
-<a href="#notes-on-the-gwidgetswww2-package" class="anchor"> </a>Notes on the gWidgetsWWW2 package</h3>
+<a href="#notes-on-the-gwidgetswww2-package" class="anchor"></a>Notes on the gWidgetsWWW2 package</h3>
<p>The R package gWidgetsWWW2 is not available on CRAN because it contains path names with more then 100 characters in the JavaScript files which limits its portability. Also, it attaches some R objects to the search path, which is, in its current form, not fully in line with the CRAN package policy. It is not a widely used library for creating graphical user interfaces and is not supported by a commercial company. However it makes it possible to create a reasonably complex user interface by just writing R code, and is therefore used by gmkin.</p>
</div>
<div id="installation-using-the-devtools-package" class="section level3">
<h3 class="hasAnchor">
-<a href="#installation-using-the-devtools-package" class="anchor"> </a>Installation using the devtools package</h3>
+<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)
@@ -120,7 +120,7 @@ install_github(<span class="st">"jranke/gmkin"</span>, quick = TRUE)</code></pre
</div>
<div id="simplifying-the-start-of-gmkin-under-windows" class="section level2">
<h2 class="hasAnchor">
-<a href="#simplifying-the-start-of-gmkin-under-windows" class="anchor"> </a>Simplifying the start of gmkin under Windows</h2>
+<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()
@@ -131,7 +131,7 @@ while (TRUE) {
</div>
<div id="acknowledgements" class="section level2">
<h2 class="hasAnchor">
-<a href="#acknowledgements" class="anchor"> </a>Acknowledgements</h2>
+<a href="#acknowledgements" class="anchor"></a>Acknowledgements</h2>
<p>Financial support, feedback and suggestions by the German Federal Environmental Agency (<a href="http://www.umweltbundesamt.de">Umweltbundesamt</a>) in two projects in 2014 and 2015 was crucial for reaching version 0.6.3 in November 2015 and is gratefully acknowledged. In particular, Stefan Meinecke contributed with a lot of user feedback and suggestions for improvement in that time.</p>
</div>
</div>
@@ -150,14 +150,12 @@ while (TRUE) {
<li>Johannes Ranke <br><small class="roles"> Author, maintainer, copyright holder </small> </li>
<li><a href="authors.html">All authors...</a></li>
</ul>
-<html><body>
<h2>Dev status</h2>
<ul class="list-unstyled">
<li><a href="http://kinfit.r-forge.r-project.org/gmkin_static">gmkin</a></li>
<li><a href="http://github.com/jranke/mkin">mkin</a></li>
<li><a href="http://github.com/jverzani/gWidgetsWWW2">gWidgetsWWW2</a></li>
</ul>
-</body></html>
</div>
</div>

Contact - Imprint