diff options
Diffstat (limited to 'docs/articles/gmkin_manual.html')
| -rw-r--r-- | docs/articles/gmkin_manual.html | 141 |
1 files changed, 70 insertions, 71 deletions
diff --git a/docs/articles/gmkin_manual.html b/docs/articles/gmkin_manual.html index a562df3..cad446a 100644 --- a/docs/articles/gmkin_manual.html +++ b/docs/articles/gmkin_manual.html @@ -6,19 +6,19 @@ <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Manual for gmkin • gmkin</title> -<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous"> -<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous"> -<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous"> -<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"> +<!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"> +<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"> +<script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"> +<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"> <script src="../pkgdown.js"></script><meta property="og:title" content="Manual for gmkin"> -<meta property="og:description" content=""> -<meta name="twitter:card" content="summary"> +<meta property="og:description" content="gmkin"> <!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></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> +<body data-spy="scroll" data-target="#toc"> <div class="container template-article"> <header><div class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="container"> @@ -31,7 +31,7 @@ </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">gmkin</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.10</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.11</span> </span> </div> @@ -39,7 +39,7 @@ <ul class="nav navbar-nav"> <li> <a href="../index.html"> - <span class="fas fa fas fa-home fa-lg"></span> + <span class="fas fa-home fa-lg"></span> </a> </li> @@ -62,7 +62,14 @@ <a href="../news/index.html">Changelog</a> </li> </ul> -<ul class="nav navbar-nav navbar-right"></ul> +<ul class="nav navbar-nav navbar-right"> +<li> + <a href="http://github.com/jranke/gmkin/"> + <span class="fab fa-github fa-lg"></span> + + </a> +</li> + </ul> </div> <!--/.nav-collapse --> </div> @@ -72,15 +79,15 @@ - </header><div class="row"> + </header><script src="gmkin_manual_files/header-attrs-2.6/header-attrs.js"></script><script src="gmkin_manual_files/accessible-code-block-0.0.1/empty-anchor.js"></script><div class="row"> <div class="col-md-9 contents"> <div class="page-header toc-ignore"> - <h1>Manual for gmkin</h1> + <h1 data-toc-skip>Manual for gmkin</h1> <h4 class="author">Johannes Ranke</h4> - <h4 class="date">2020-02-07</h4> - + <h4 class="date">2021-02-12</h4> + <small class="dont-index">Source: <a href="http://github.com/jranke/gmkin/blob/master/vignettes/gmkin_manual.Rmd"><code>vignettes/gmkin_manual.Rmd</code></a></small> <div class="hidden name"><code>gmkin_manual.Rmd</code></div> </div> @@ -97,16 +104,18 @@ <h2 class="hasAnchor"> <a href="#starting-gmkin" class="anchor"></a>Starting gmkin</h2> <p>As gmkin is an R package, you need to start R and load the gmkin package before you can run gmkin. The latter can be achieved by entering the command</p> -<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb1-1" title="1"><span class="kw"><a href="https://rdrr.io/r/base/library.html">library</a></span>(gmkin)</a></code></pre></div> +<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r"> +<code class="sourceCode R"><span class="kw"><a href="https://rdrr.io/r/base/library.html">library</a></span><span class="op">(</span><span class="va"><a href="http://pkgdown.jrwb.de/gmkin">gmkin</a></span><span class="op">)</span></code></pre></div> <p>into the R console. This will also load the packages that gmkin depends on, most notably gWidgetsWWW2 and mkin. Loading the package only has to be done once after you have started R.</p> <p>Before you start gmkin, you should make sure that R is using the working directory that you would like to keep your gmkin project file(s) in. If you use the standard R GUI application on windows, you can change the working directory from the File menu (‘File’ -> ‘Change dir…’).</p> <p>Once you are sure that the working directory is what you want it to be, gmkin can be started by entering the R command</p> -<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb2-1" title="1"><span class="kw"><a href="../reference/gmkin.html">gmkin</a></span>()</a></code></pre></div> +<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r"> +<code class="sourceCode R"><span class="fu"><a href="../reference/gmkin.html">gmkin</a></span><span class="op">(</span><span class="op">)</span></code></pre></div> <p>This will cause the default browser to start up or, if it is already running, to pop up and open a new tab for displaying the gmkin user interface.</p> <p>In the R console, you should see a message that the httpd help server is started, if it wasn’t already started before.</p> <p>In the browser, you should see something like the screenshot below.</p> <div class="figure"> -<img src="img/gmkin_start.png" alt="Screenshot of the newly started gmkin GUI"><p class="caption">Screenshot of the newly started gmkin GUI</p> +<img src="img/gmkin_start.png" alt=""><p class="caption">Screenshot of the newly started gmkin GUI</p> </div> <p>The statusbar at the bottom of the gmkin window shows, among others, the working directory that gmkin uses.</p> <p>If the browser only shows “Loading ExtJS…” and nothing else happens for about 10 to 15 seconds, please enter the <code><a href="../reference/gmkin.html">gmkin()</a></code> command again in the R console. If this still does not bring up the gmkin GUI, please close the browser and try again.</p> @@ -124,16 +133,16 @@ <p>A gmkin project workspace contains datasets, kinetic models for fitting, and so-called fits, i.e. the results of fitting models to data. The project area also shows the current working directory, where project workspace files are saved using the file extension <code>.gmkinws</code>.</p> <p>Once a project has been saved by the user, the project explorer to the left will show it in the project list.</p> <div class="figure"> -<img src="img/new_project.png" alt="Screenshot of saving a new project"><p class="caption">Screenshot of saving a new project</p> +<img src="img/new_project.png" alt=""><p class="caption">Screenshot of saving a new project</p> </div> <p>The current state of a project should repeatedly be saved during the work in order to avoid loosing data. This can be achieved by selecting the ‘Project’ tab in the center and pressing the ‘Save project to project file’ button. More conveniently, the keyboard shortcut Shift-F12 (was Ctrl-X in gmkin < 0.6.6) can be used to save the current status of the project.</p> <p>In the project file management area, datasets and models can be imported from one of the projects in the project list, once it has been selected in the droplist labelled ‘Import from:’.</p> <div class="figure"> -<img src="img/import.png" alt="Screenshot of importing datasets and models"><p class="caption">Screenshot of importing datasets and models</p> +<img src="img/import.png" alt=""><p class="caption">Screenshot of importing datasets and models</p> </div> <p>Once the project has been set up, you may want to minimize the project explorer, especially if you are limited in vertical screen space.</p> <div class="figure"> -<img src="img/projects_min.png" alt="Screenshot of minimized project explorer"><p class="caption">Screenshot of minimized project explorer</p> +<img src="img/projects_min.png" alt=""><p class="caption">Screenshot of minimized project explorer</p> </div> </div> <div id="dataset-editor" class="section level2"> @@ -141,7 +150,7 @@ <a href="#dataset-editor" class="anchor"></a>Dataset editor</h2> <p>When you select one of the datasets in the dataset explorer to the left, some summary information about the dataset is shown in the center, and the data itself is loaded into the data editor to the right.</p> <div class="figure"> -<img src="img/dataset_Z.png" alt="Screenshot of the GUI after loading a dataset"><p class="caption">Screenshot of the GUI after loading a dataset</p> +<img src="img/dataset_Z.png" alt=""><p class="caption">Screenshot of the GUI after loading a dataset</p> </div> <p>When you have added information about the units, or edited the data to the right, you should hit the button ‘Keep changes’. This will add a new entry in the dataset explorer.</p> <p>In the dataset editor to the right, you can override original data (for example in order to follow FOCUS recommendations for time zero samples or values below the limit of detection) by entering numbers in the override column.</p> @@ -150,10 +159,10 @@ <div id="entering-data-directly" class="section level3"> <h3 class="hasAnchor"> <a href="#entering-data-directly" class="anchor"></a>Entering data directly</h3> -<p>For entering new data manually, there are two possibilities. You can either change the Dataset title of the current dataset and edit the data in the Data editor to the right. Or, if the new data should have a different structure, e.g. different sampling times, observed variables and replicates, click on “New dataset”, edit the dataset title, sampling times, number of replicates and the list of observed variables, and press the button ‘Generate grid for entering kinetic data’, in order to prepare the Data editor to the right.</p> +<p>For entering new data manually, there are two possibilities. You can either change the Dataset title of the current dataset and edit the data in the Data editor to the right. Or, if the new data should have a different structure, e.g. different sampling times, observed variables and replicates, click on “New dataset”, edit the dataset title, sampling times, number of replicates and the list of observed variables, and press the button ‘Generate grid for entering kinetic data’, in order to prepare the Data editor to the right.</p> <p>For sampling times and short names of the relevant compounds, a comma separated list must be entered, with a space after each comma. An example of filling out the respective fields is shown below.</p> <div class="figure"> -<img src="img/generatedatagrid.png" alt="Screenshot of generating a data grid"><p class="caption">Screenshot of generating a data grid</p> +<img src="img/generatedatagrid.png" alt=""><p class="caption">Screenshot of generating a data grid</p> </div> <p>After that, the actual measurements can be entered into the Data editor to the right, in the column ‘value’.</p> <p>If everything is OK, press “Keep changes” to save the dataset in the current workspace. Note that you need to save the project file (see above) in order to be able to use the dataset that you created in a future gmkin session.</p> @@ -163,17 +172,18 @@ <a href="#importing-data-from-text-files" class="anchor"></a>Importing data from text files</h3> <p>In case you want to work with a larger dataset that is already available as a computer file e.g. in a spreadsheet application, you can export these data as a tab separated or comma separated text file and import it using the “Browse” and “Upload” buttons in the dataset editor.</p> <p>As an example, we can create a text file from one of the datasets shipped with the mkin package using the following R command:</p> -<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb3-1" title="1"><span class="kw"><a href="https://rdrr.io/r/utils/write.table.html">write.table</a></span>(schaefer07_complex_case, <span class="dt">sep =</span> <span class="st">","</span>, <span class="dt">dec =</span> <span class="st">"."</span>,</a> -<a class="sourceLine" id="cb3-2" title="2"> <span class="dt">row.names =</span> <span class="ot">FALSE</span>, <span class="dt">quote =</span> <span class="ot">FALSE</span>,</a> -<a class="sourceLine" id="cb3-3" title="3"> <span class="dt">file =</span> <span class="st">"schaefer07.csv"</span>)</a></code></pre></div> +<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r"> +<code class="sourceCode R"><span class="fu"><a href="https://rdrr.io/r/utils/write.table.html">write.table</a></span><span class="op">(</span><span class="va">schaefer07_complex_case</span>, sep <span class="op">=</span> <span class="st">","</span>, dec <span class="op">=</span> <span class="st">"."</span>, + row.names <span class="op">=</span> <span class="cn">FALSE</span>, quote <span class="op">=</span> <span class="cn">FALSE</span>, + file <span class="op">=</span> <span class="st">"schaefer07.csv"</span><span class="op">)</span></code></pre></div> <p>This produces a text file with comma separated values in the current working directory of R.</p> <p>Loading this text file into gmkin using the “Browse” and “Upload” buttons</p> <div class="figure"> -<img src="img/upload_dialogue.png" alt="Screenshot of the browse and upload dialogue"><p class="caption">Screenshot of the browse and upload dialogue</p> +<img src="img/upload_dialogue.png" alt=""><p class="caption">Screenshot of the browse and upload dialogue</p> </div> <p>results in an an import configuration area showing the top lines of the imported file, and giving the possibility to chose the import options matching the file format.</p> <div class="figure"> -<img src="img/uploadarea.png" alt="Screenshot of the import configuration area"><p class="caption">Screenshot of the import configuration area</p> +<img src="img/uploadarea.png" alt=""><p class="caption">Screenshot of the import configuration area</p> </div> <p>In the import configuration area, the following options can be specified. In the field “Comment lines”, the number of lines in the beginning of the file that should be ignored can be specified.</p> <p>The checkbox on the next line should be checked if the first line of the file contains the column names, i.e. the names of the observed variables when the data are in wide format.</p> @@ -181,11 +191,11 @@ <p>As the “Decimal” separator, comma “,” or period “.” can be selected.</p> <p>In the next line, it can be specified if the data are in wide or in long format. If in wide format, the only option left to specify is the title of the column containing the sampling times. If the data is in long format, the column headings specifying the columns containing the observed variables (default is “name”), the sampling times (default is “time”), the observed values (default is “value”) and, if present in the data, the relative errors (default is “err”) can be adapted. The default settings appearing if the long format is selected are shown below.</p> <div class="figure"> -<img src="img/long.png" alt="Screenshot of the default variable names for data in long format"><p class="caption">Screenshot of the default variable names for data in long format</p> +<img src="img/long.png" alt=""><p class="caption">Screenshot of the default variable names for data in long format</p> </div> <p>In our example we have data in the wide format, and after adapting the “Separator” to a comma, we can press the button “Import using options specified below”, and the data should be imported. If successful, the dataset editor should show the sampling times and the names of the observed variables, and the Data editor should show the imported data in a grid for further editing or specifying overrides.</p> <div class="figure"> -<img src="img/successfulupload.png" alt="Screenshot of a successful upload"><p class="caption">Screenshot of a successful upload</p> +<img src="img/successfulupload.png" alt=""><p class="caption">Screenshot of a successful upload</p> </div> <p>After adapting the dataset title and possibly the units, press “Keep changes” to save the dataset in the current workspace. Again, you need to save the project file in order to be able to use the dataset that you created in a future gmkin session.</p> </div> @@ -195,10 +205,10 @@ <a href="#model-editor" class="anchor"></a>Model editor</h2> <p>The following screenshot shows the model editor for the model ‘Z.2a.ff’ from the project workspace ‘FOCUS_2006_Z’ provided with the gmkin package.</p> <div class="figure"> -<img src="img/modeleditor.png" alt="Screenshot of the model editor"><p class="caption">Screenshot of the model editor</p> +<img src="img/modeleditor.png" alt=""><p class="caption">Screenshot of the model editor</p> </div> <p>In the first line the name of the model can be edited. You can also specify “min” or “max” for minimum or maximum use of formation fractions. Maximum use of formation fractions means that the differential equations in the degradation model are formulated using formation fractions. When you specify “min”, then formation fractions are only used for the parent compound when you use the FOMC, DFOP or the HS model for it.</p> -<p>Pressing “Add observed variable” adds a line in the array of state variable specifications below. The observed variables to be added are usually transformation products (usually termed metabolites), but can also be the parent compound in a different compartment (e.g. “parent_sediment”).</p> +<p>Pressing “Add observed variable” adds a line in the array of state variable specifications below. The observed variables to be added are usually transformation products (usually termed metabolites), but can also be the parent compound in a different compartment (e.g. “parent_sediment”).</p> <p>Only observed variable names that occur in previously defined datasets or models can be selected. For any observed variable other than the first one, only the SFO or the SFORB model can be selected. For each observed variables, a comma separated list of target variables can be specified. In addition, a pathway to the sink compartment can be selected. If too many observed variables have been added, complete lines can be removed from the model definition by pressing the button “Remove observed variable”.</p> <p>If the model definition is supposedly correct, press “Keep changes” to make it possible to select it for fitting in the listing of models to the left.</p> </div> @@ -208,7 +218,7 @@ <p>If a dataset and a kinetic model are selected, the button “Configure fit” below in the Explorer window “Configuration” becomes active. Pressing it opens the “Configuration” area in the center and loads the dataset into the Data editor to the right, for viewing only.</p> <p>After pressing the button ‘Plot unoptimised’, the data and the kinetic model with default starting parameters are plotted in the ‘Plot’ area to the right.</p> <div class="figure"> -<img src="img/configuration.png" alt="Screenshot of the fit configuration area"><p class="caption">Screenshot of the fit configuration area</p> +<img src="img/configuration.png" alt=""><p class="caption">Screenshot of the fit configuration area</p> </div> <div id="fit-options" class="section level3"> <h3 class="hasAnchor"> @@ -226,7 +236,7 @@ <a href="#plot-options" class="anchor"></a>Plot options</h3> <p>In the right part of the fit configuration area, the file format can be chosen, the legend can be turned off, and the observed variables for which the data and the model fit should be plotted can be selected as shown below.</p> <div class="figure"> -<img src="img/plotoptions.png" alt="plot options"><p class="caption">plot options</p> +<img src="img/plotoptions.png" alt=""><p class="caption">plot options</p> </div> <p>On systems running the Windows operating system, the enhanced metafile (emf) format can be additionally chosen. Changing the file format for plotting will also change the extension of the proposed filename for saving the plot.</p> </div> @@ -242,25 +252,25 @@ <h3 class="hasAnchor"> <a href="#fitting-the-model" class="anchor"></a>Fitting the model</h3> <p>In many cases the starting parameters and the fit options do not need to be modified and the model fitting process can simply be started by pressing the “Run fit” button. In the R console, the progressive reduction in the model cost can be monitored and will be displayed in the following way:</p> -<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><a class="sourceLine" id="cb4-1" title="1"><span class="op">></span><span class="st"> </span>Ordinary least squares optimisation</a> -<a class="sourceLine" id="cb4-2" title="2">Sum of squared residuals at call <span class="dv">1</span><span class="op">:</span><span class="st"> </span><span class="fl">2388.077</span></a> -<a class="sourceLine" id="cb4-3" title="3">Sum of squared residuals at call <span class="dv">3</span><span class="op">:</span><span class="st"> </span><span class="fl">2388.077</span></a> -<a class="sourceLine" id="cb4-4" title="4">Sum of squared residuals at call <span class="dv">4</span><span class="op">:</span><span class="st"> </span><span class="fl">247.1962</span></a> -<a class="sourceLine" id="cb4-5" title="5">Sum of squared residuals at call <span class="dv">7</span><span class="op">:</span><span class="st"> </span><span class="fl">200.6791</span></a> -<a class="sourceLine" id="cb4-6" title="6">Sum of squared residuals at call <span class="dv">10</span><span class="op">:</span><span class="st"> </span><span class="fl">197.7231</span></a> -<a class="sourceLine" id="cb4-7" title="7">Sum of squared residuals at call <span class="dv">11</span><span class="op">:</span><span class="st"> </span><span class="fl">197.0872</span></a> -<a class="sourceLine" id="cb4-8" title="8">Sum of squared residuals at call <span class="dv">14</span><span class="op">:</span><span class="st"> </span><span class="fl">196.535</span></a> -<a class="sourceLine" id="cb4-9" title="9">Sum of squared residuals at call <span class="dv">15</span><span class="op">:</span><span class="st"> </span><span class="fl">196.535</span></a> -<a class="sourceLine" id="cb4-10" title="10">Sum of squared residuals at call <span class="dv">16</span><span class="op">:</span><span class="st"> </span><span class="fl">196.535</span></a> -<a class="sourceLine" id="cb4-11" title="11">Sum of squared residuals at call <span class="dv">17</span><span class="op">:</span><span class="st"> </span><span class="fl">196.5334</span></a> -<a class="sourceLine" id="cb4-12" title="12">Sum of squared residuals at call <span class="dv">20</span><span class="op">:</span><span class="st"> </span><span class="fl">196.5334</span></a> -<a class="sourceLine" id="cb4-13" title="13">Sum of squared residuals at call <span class="dv">25</span><span class="op">:</span><span class="st"> </span><span class="fl">196.5334</span></a> -<a class="sourceLine" id="cb4-14" title="14">Negative log<span class="op">-</span>likelihood at call <span class="dv">31</span><span class="op">:</span><span class="st"> </span><span class="fl">26.64668</span></a> -<a class="sourceLine" id="cb4-15" title="15">Optimisation successfully terminated.</a></code></pre></div> +<div class="sourceCode" id="cb4"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true"></a><span class="op">></span><span class="st"> </span>Ordinary least squares optimisation</span> +<span id="cb4-2"><a href="#cb4-2" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">1</span><span class="op">:</span><span class="st"> </span><span class="fl">2388.077</span></span> +<span id="cb4-3"><a href="#cb4-3" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">3</span><span class="op">:</span><span class="st"> </span><span class="fl">2388.077</span></span> +<span id="cb4-4"><a href="#cb4-4" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">4</span><span class="op">:</span><span class="st"> </span><span class="fl">247.1962</span></span> +<span id="cb4-5"><a href="#cb4-5" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">7</span><span class="op">:</span><span class="st"> </span><span class="fl">200.6791</span></span> +<span id="cb4-6"><a href="#cb4-6" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">10</span><span class="op">:</span><span class="st"> </span><span class="fl">197.7231</span></span> +<span id="cb4-7"><a href="#cb4-7" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">11</span><span class="op">:</span><span class="st"> </span><span class="fl">197.0872</span></span> +<span id="cb4-8"><a href="#cb4-8" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">14</span><span class="op">:</span><span class="st"> </span><span class="fl">196.535</span></span> +<span id="cb4-9"><a href="#cb4-9" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">15</span><span class="op">:</span><span class="st"> </span><span class="fl">196.535</span></span> +<span id="cb4-10"><a href="#cb4-10" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">16</span><span class="op">:</span><span class="st"> </span><span class="fl">196.535</span></span> +<span id="cb4-11"><a href="#cb4-11" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">17</span><span class="op">:</span><span class="st"> </span><span class="fl">196.5334</span></span> +<span id="cb4-12"><a href="#cb4-12" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">20</span><span class="op">:</span><span class="st"> </span><span class="fl">196.5334</span></span> +<span id="cb4-13"><a href="#cb4-13" aria-hidden="true"></a>Sum of squared residuals at call <span class="dv">25</span><span class="op">:</span><span class="st"> </span><span class="fl">196.5334</span></span> +<span id="cb4-14"><a href="#cb4-14" aria-hidden="true"></a>Negative log<span class="op">-</span>likelihood at call <span class="dv">31</span><span class="op">:</span><span class="st"> </span><span class="fl">26.64668</span></span> +<span id="cb4-15"><a href="#cb4-15" aria-hidden="true"></a>Optimisation successfully terminated.</span></code></pre></div> <p>If plotting of the fitting progress was selected, a new separate graphics window should either pop up, or a graphics window previously started for this purpose will be reused.</p> <p>If your screen size allows for it, you can arrange the R plotting window and the R console in a way that you can see everything at the same time:</p> <div class="figure"> -<img src="img/arrangement.png" alt="Screenshot of arrangement of plot window and console"><p class="caption">Screenshot of arrangement of plot window and console</p> +<img src="img/arrangement.png" alt=""><p class="caption">Screenshot of arrangement of plot window and console</p> </div> </div> </div> @@ -269,20 +279,20 @@ <a href="#results-and-summary" class="anchor"></a>Results and summary</h2> <p>Once a fit has successfully been completed, the most important results are shown in several tables in the “Result” area as shown below.</p> <div class="figure"> -<img src="img/results.png" alt="Screenshot of the results"><p class="caption">Screenshot of the results</p> +<img src="img/results.png" alt=""><p class="caption">Screenshot of the results</p> </div> <p>The detailed summary can be accessed below these tables.</p> <div class="figure"> -<img src="img/summary.png" alt="Screenshot of the summary"><p class="caption">Screenshot of the summary</p> +<img src="img/summary.png" alt=""><p class="caption">Screenshot of the summary</p> </div> <p>The complete summary can be saved into a text file by specifying a suitable file name and pressing the button “Save summary”.</p> <div id="confidence-interval-plots" class="section level3"> <h3 class="hasAnchor"> <a href="#confidence-interval-plots" class="anchor"></a>Confidence interval plots</h3> <p>Whenever a new fit has been configured or a run of a fit has been completed, the plotting area is updated with the abovementioned plot of the data and the current model solution.</p> -<p>In addition, a confidence interval plot is shown below this conventional plot. In case a fit has been run and confidence intervals were successfully calculated for the fit ( i.e. if the model was not overparameterised and no other problems occurred), the confidence intervals are graphically displayed as bars as shown below.</p> +<p>In addition, a confidence interval plot is shown below this conventional plot. In case a fit has been run and confidence intervals were successfully calculated for the fit (i.e. if the model was not overparameterised and no other problems occurred), the confidence intervals are graphically displayed as bars as shown below.</p> <div class="figure"> -<img src="img/confidence.png" alt="confidence"><p class="caption">confidence</p> +<img src="img/confidence.png" alt=""><p class="caption">confidence</p> </div> </div> </div> @@ -303,6 +313,8 @@ <li>In the pop-up window that appears, press ‘Yes’</li> <li>In the result viewer in the center, press ‘Keep fit’</li> <li>Switch to the Project editor in the center</li> +<li>Check that the working directory is OK for writing a test project</li> +<li>If not, enter a suitable path (e.g. “~” which will be resolved to your home directory) and press ‘Change’</li> <li>In the project explorer, enter the project name ‘Howto test 1’</li> <li>Press ‘Save project to project file’</li> </ul> @@ -373,24 +385,11 @@ </div> </div> - <div class="col-md-3 hidden-xs hidden-sm" id="sidebar"> + <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> - <div id="tocnav"> - <h2 class="hasAnchor"> -<a href="#tocnav" class="anchor"></a>Contents</h2> - <ul class="nav nav-pills nav-stacked"> -<li><a href="#introduction">Introduction</a></li> - <li><a href="#starting-gmkin">Starting gmkin</a></li> - <li><a href="#three-column-layout">Three column layout</a></li> - <li><a href="#project-file-management">Project file management</a></li> - <li><a href="#dataset-editor">Dataset editor</a></li> - <li><a href="#model-editor">Model editor</a></li> - <li><a href="#configuring-the-fit">Configuring the fit</a></li> - <li><a href="#results-and-summary">Results and summary</a></li> - <li><a href="#howtos">Howtos</a></li> - </ul> + <nav id="toc" data-toggle="toc"><h2 data-toc-skip>Contents</h2> + </nav> </div> - </div> </div> @@ -401,7 +400,7 @@ </div> <div class="pkgdown"> - <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p> + <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p> </div> </footer> |