From 71468046acbaf005173ababa0fe5ffb9c6426278 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Mon, 6 Mar 2017 15:39:58 +0100 Subject: Static documentation built by pkgdown Not by staticdocs any more --- docs/reference/FOCUS_2006.html | 142 ++++++++++++++++++++++++++++++ docs/reference/FOCUS_2006_Z.html | 139 ++++++++++++++++++++++++++++++ docs/reference/UBA_model_gallery.html | 140 ++++++++++++++++++++++++++++++ docs/reference/gmkin.html | 158 ++++++++++++++++++++++++++++++++++ docs/reference/gmkinws.html | 131 ++++++++++++++++++++++++++++ docs/reference/index.html | 142 ++++++++++++++++++++++++++++++ 6 files changed, 852 insertions(+) create mode 100644 docs/reference/FOCUS_2006.html create mode 100644 docs/reference/FOCUS_2006_Z.html create mode 100644 docs/reference/UBA_model_gallery.html create mode 100644 docs/reference/gmkin.html create mode 100644 docs/reference/gmkinws.html create mode 100644 docs/reference/index.html (limited to 'docs/reference') diff --git a/docs/reference/FOCUS_2006.html b/docs/reference/FOCUS_2006.html new file mode 100644 index 0000000..86ba53e --- /dev/null +++ b/docs/reference/FOCUS_2006.html @@ -0,0 +1,142 @@ + + + + + + + + + + — FOCUS_2006 • gmkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

+

+
+ + +

An gmkinws object with data taken from FOCUS (2006), Appendix + 3. This is the the workspace that is loaded into gmkin by + default.

+ + + 
FOCUS_2006
+ +

Format

+ +

A list named FOCUS_2006 containing the components + needed to populate the gmkin user interface.

+ +

Source

+ +

FOCUS (2006) “Guidance Document on Estimating Persistence and + Degradation Kinetics from Environmental Fate Studies on Pesticides in EU + Registration” Report of the FOCUS Work Group on Degradation Kinetics, + EC Document Reference Sanco/10058/2005 version 2.0, 434 pp, + http://focus.jrc.ec.europa.eu/dk

+ + +

Examples

+ 
  ## Not run: ------------------------------------
+#   save(FOCUS_2006, file = "FOCUS_2006.RData")
+#   # Now you can load the file "FOCUS_2006.RData" from gmkin,
+#   # restoring the workspace that is loaded at startup.
+#   
+## ---------------------------------------------
+
+ +
+ +
+
+

Developed by Johannes Ranke.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/FOCUS_2006_Z.html b/docs/reference/FOCUS_2006_Z.html new file mode 100644 index 0000000..7caa7d1 --- /dev/null +++ b/docs/reference/FOCUS_2006_Z.html @@ -0,0 +1,139 @@ + + + + + + + + + + — FOCUS_2006_Z • gmkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

+

+
+ + +

Data taken from FOCUS (2006), Appendix 7, p. 350.

+ + + 
FOCUS_2006_Z
+ +

Format

+ +

An gmkinws object with dataset Z taken from FOCUS (2006), + together with most of the models used in the corresponding vignette.

+ +

Source

+ +

FOCUS (2006) “Guidance Document on Estimating Persistence and + Degradation Kinetics from Environmental Fate Studies on Pesticides in EU + Registration” Report of the FOCUS Work Group on Degradation Kinetics, + EC Document Reference Sanco/10058/2005 version 2.0, 434 pp, + http://focus.jrc.ec.europa.eu/dk

+ + +

Examples

+ 
  ## Not run: ------------------------------------
+#   save(FOCUS_2006_Z, file = "FOCUS_2006_Z.RData")
+#   # Now you can load the file "FOCUS_2006_Z.RData" from gmkin
+#   
+## ---------------------------------------------
+
+ +
+ +
+
+

Developed by Johannes Ranke.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/UBA_model_gallery.html b/docs/reference/UBA_model_gallery.html new file mode 100644 index 0000000..92d6f89 --- /dev/null +++ b/docs/reference/UBA_model_gallery.html @@ -0,0 +1,140 @@ + + + + + + + + + + — UBA_model_gallery • gmkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

+

+
+ + +

The UBA model gallery contains predefined kinetic models for some common use + cases, with metabolites named as in the commonly used PELMO degradation + scheme (Jene 1998). Please use the model gallery of the gmkin + GUI to see their definitions. The models use the topology of the models + defined by Michael Klein (2010) for DegKinManager, with the exception of the + kinetic sorption model.

+ + + 
data("UBA_model_gallery")
+ +

Format

+ +

A list containing 9 lists of four mkinmod models.

+ +

References

+ +

Klein M (2010) Calculation of rates constants according to FOCUS degradation + kinetics using DegKinManager and ModelMaker. Project report of UBA project + FKZ 360 03 048

+

Jene B (1998) PELMO 3.00 Manual extension, Staatliche Lehr- und + Forschungsanstalt für Landwirtschaft, Weinbau und Gartenbau, D-67435 + Neustadt/Wstr.

+ + +

Examples

+ 
data(UBA_model_gallery)
+
+ +
+ +
+
+

Developed by Johannes Ranke.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/gmkin.html b/docs/reference/gmkin.html new file mode 100644 index 0000000..da80908 --- /dev/null +++ b/docs/reference/gmkin.html @@ -0,0 +1,158 @@ + + + + + + + + + + — gmkin • gmkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

+

+
+ + +

This function starts a browser based GUI. Please visit the + http://github.com/jverzani/gWidgetsWWW2 + for an explanation how this toolkit works.

+ + + 
gmkin(script_name, show.log = FALSE)
+ +

Arguments

+
+
script_name
+
+ 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. +
+
show.log
+
+ During development, it may be useful to see the log of the Rook apps. +
+
+ +

Value

+ +

The function is called for its side effect, namely starting the GUI in a browser. + For the curious, the desperate or the adventurous, the gmkin app (a GWidgetsApp object) is returned.

+ + +

Examples

+ 
  ## Not run: gmkin() # Start the gmkin GUI
+  ## Not run: ------------------------------------
+#     g <- gmkin()
+# 
+#     # Only for debugging or other advanced usage:
+#     session <- gmkin:::get_current_session(g)
+#     session$p.df
+#     session$ds.df
+#     session$ds.cur
+#     session$m.cur
+#     session$ws
+#   
+## ---------------------------------------------
+
+ +
+ +
+
+

Developed by Johannes Ranke.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/gmkinws.html b/docs/reference/gmkinws.html new file mode 100644 index 0000000..203579e --- /dev/null +++ b/docs/reference/gmkinws.html @@ -0,0 +1,131 @@ + + + + + + + + +A workspace class for gmkin — gmkinws • gmkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

A workspace class for gmkin

+
+ + +

Datasets, models and fits are stored in lists.

+ + + 
gmkinws
+ +

Format

+ +

An R6Class generator object.

+ +

Fields

+ +

+

+
observed
Names of the observed variables in the datasets, named +by the names used in the models contained in field m

+

ds
A list of datasets compatible with mkinfit (long format)

+

m
A list of mkinmod models

+

f
A list of mkinfit objects
+

+ + +
+ +
+ +
+
+

Developed by Johannes Ranke.

+
+ +
+

Site built with pkgdown.

+
+ +
+
+ + + diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..ecd5dcd --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,142 @@ + + + + + + + + +Function reference • gmkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Function reference

+

version 0.6.8

+
+ +
+

All functions

+

+ + +

+

+ + +

+

+ + +

+

+ + +

A workspace class for gmkin

+ + +

+

+ + +
+
+ + +
+ + +
+ + + -- cgit v1.2.1