aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2021-02-13 22:01:37 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2021-02-13 22:01:37 +0100
commit8b1877ff07d3ab11472bcdba0f273abb2432c0b4 (patch)
tree8d6620a4c917b06c769719066fabe203e60bf669
parent4252d9b44ceecfecabd3977fc12f11ed85d78e93 (diff)
More updates to the README
-rw-r--r--README.html8
-rw-r--r--README.md22
-rw-r--r--docs/index.html8
-rw-r--r--docs/pkgdown.yml2
4 files changed, 20 insertions, 20 deletions
diff --git a/README.html b/README.html
index 62d2245..c6e5e9d 100644
--- a/README.html
+++ b/README.html
@@ -393,7 +393,7 @@ summary {
<p>The R package <a href="https://pkgdown.jrwb.de/gmkin">gmkin</a> provides a browser based graphical user interface (GUI) for fitting kinetic models to chemical degradation data based on R package <a href="https://pkgdown.jrwb.de/mkin">mkin</a>. The GUI is based on the <a href="http://github.com/jverzani/gWidgetsWWW2">gWidgetsWWW2</a> package developed by John Verzani. The GUI elements are created by the JavaScript library ExtJS which is bundled with gWidgetsWWW2.</p>
<div id="system-requirements" class="section level2">
<h2>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>For running current gmkin you need a system running a recent version of R (4.0.x, on Linux older versions may work as well), the gWidgesWWW2 package, the gmkin package and a web browser (Firefox 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 7 or Windows 10.</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">
@@ -403,7 +403,7 @@ summary {
</div>
<div id="installing-gmkin-and-gwidgetswww2" class="section level3">
<h3>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>
+<p>Windows and Linux users 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>
<pre class="s"><code>update.packages()</code></pre>
<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>
@@ -460,8 +460,8 @@ gmkin()
while (TRUE) {
Sys.sleep(10)
}</code></pre>
-<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>&quot;C:\Program Files\R\R-4.x.y\bin\R.exe&quot; --slave -f c:\Users\&lt;your username&gt;\AppData\Roaming\gmkin_start.R</code>, where R-4.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>
-<p>Caveat: The last time I tested this (13 February 2021), starting gmkin with such a shortcut slowed down loading the GUI elements significantly. This was under Windows 10 64 bit. Therefore, for Windows I would currently recommend to start the R GUI application and start gmkin from there as described under ‘Usage’.</p>
+<p>in 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>&quot;C:\Program Files\R\R-4.x.y\bin\R.exe&quot; --slave -f c:\Users\&lt;your username&gt;\AppData\Roaming\gmkin_start.R</code>, where R-4.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>
+<p>Caveat: The last time I tested this (13 February 2021), starting gmkin with such a shortcut slowed down the loading of the GUI elements significantly. This was under Windows 10 64 bit. Therefore, for Windows I would currently recommend to start the R GUI application and start gmkin from there as described above under ‘Usage’.</p>
</div>
<div id="acknowledgements" class="section level2">
<h2>Acknowledgements</h2>
diff --git a/README.md b/README.md
index 6e09f34..267d54c 100644
--- a/README.md
+++ b/README.md
@@ -10,9 +10,10 @@ ExtJS which is bundled with gWidgetsWWW2.
## System requirements
-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.
+For running current gmkin you need a system running a recent version of
+R (4.0.x, on Linux older versions may work as well), the gWidgesWWW2 package,
+the gmkin package and a web browser (Firefox and Chrome work for me) with
+JavaScript enabled.
It should be possible to run gmkin on most laptop or desktop computers running
Linux, Mac OS X, Windows 7 or Windows 10.
@@ -35,7 +36,7 @@ respective
### Installing gmkin and gWidgetsWWW2
-Windows and Linux users running R 3.1.0 or later can make use of my drat
+Windows and Linux users 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
@@ -149,21 +150,21 @@ while (TRUE) {
}
```
-into an R script (e.g. under `C:\Users\<your username>\AppData\Roaming\gmkin_start.R`),
+in an R script (e.g. under `C:\Users\<your username>\AppData\Roaming\gmkin_start.R`),
and create a Windows shortcut, e.g. on the Desktop, with the target
`"C:\Program Files\R\R-4.x.y\bin\R.exe" --slave -f c:\Users\<your username>\AppData\Roaming\gmkin_start.R`,
where R-4.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
+trick with using 'Sys.sleep' in a while loop and for suggesting the AppData
directory for the start script.
Caveat: The last time I tested this (13 February 2021), starting gmkin with
-such a shortcut slowed down loading the GUI elements significantly. This was
-under Windows 10 64 bit. Therefore, for Windows I would currently recommend to
-start the R GUI application and start gmkin from there as described under
-'Usage'.
+such a shortcut slowed down the loading of the GUI elements significantly. This
+was under Windows 10 64 bit. Therefore, for Windows I would currently recommend
+to start the R GUI application and start gmkin from there as described above
+under 'Usage'.
## Acknowledgements
@@ -175,4 +176,3 @@ of user feedback and suggestions for improvement in that time.
The adaptation to mkin versions > 0.9.49.6 that can do fits using a two-component
error model was supported by another project by the Umweltbundesamt in 2018/2019.
-
diff --git a/docs/index.html b/docs/index.html
index b928dd7..41012f2 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -90,7 +90,7 @@
<div id="system-requirements" class="section level2">
<h2 class="hasAnchor">
<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>For running current gmkin you need a system running a recent version of R (4.0.x, on Linux older versions may work as well), the gWidgesWWW2 package, the gmkin package and a web browser (Firefox 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 7 or Windows 10.</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">
@@ -102,7 +102,7 @@
<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>
-<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>
+<p>Windows and Linux users 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" id="cb1"><pre class="sourceCode s"><code class="sourceCode gnuassembler"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true"></a>update.packages()</span></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>
@@ -162,8 +162,8 @@
<span id="cb7-3"><a href="#cb7-3" aria-hidden="true"></a>while (TRUE) {</span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true"></a> Sys.sleep(<span class="dv">10</span>)</span>
<span id="cb7-5"><a href="#cb7-5" aria-hidden="true"></a>}</span></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-4.x.y\bin\R.exe" --slave -f c:\Users\&lt;your username&gt;\AppData\Roaming\gmkin_start.R</code>, where R-4.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>
-<p>Caveat: The last time I tested this (13 February 2021), starting gmkin with such a shortcut slowed down loading the GUI elements significantly. This was under Windows 10 64 bit. Therefore, for Windows I would currently recommend to start the R GUI application and start gmkin from there as described under ‘Usage’.</p>
+<p>in 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-4.x.y\bin\R.exe" --slave -f c:\Users\&lt;your username&gt;\AppData\Roaming\gmkin_start.R</code>, where R-4.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>
+<p>Caveat: The last time I tested this (13 February 2021), starting gmkin with such a shortcut slowed down the loading of the GUI elements significantly. This was under Windows 10 64 bit. Therefore, for Windows I would currently recommend to start the R GUI application and start gmkin from there as described above under ‘Usage’.</p>
</div>
<div id="acknowledgements" class="section level2">
<h2 class="hasAnchor">
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index b73cd6b..448fc55 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -3,5 +3,5 @@ pkgdown: 1.6.1
pkgdown_sha: ~
articles:
gmkin_manual: gmkin_manual.html
-last_built: 2021-02-13T17:23Z
+last_built: 2021-02-13T21:01Z

Contact - Imprint