From ccc70e82af4ba435f0a71ba1ae4e0e92045c3852 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 5 May 2017 12:46:31 +0200 Subject: Static docs except articles rebuilt with current pkgdown --- docs/reference/mmkin.html | 91 +++++++++++++++++++++++++---------------------- 1 file changed, 48 insertions(+), 43 deletions(-) (limited to 'docs/reference/mmkin.html') diff --git a/docs/reference/mmkin.html b/docs/reference/mmkin.html index 67397827..fe10c88f 100644 --- a/docs/reference/mmkin.html +++ b/docs/reference/mmkin.html @@ -6,8 +6,7 @@ - - — mmkin • mkin +Fit one or more kinetic models with one or more state variables to one or more datasets — mmkin • mkin @@ -26,12 +25,14 @@ - + + + @@ -71,6 +72,9 @@
  • Performance benefit by using compiled model definitions in mkin
    • +
  • + Calculation of time weighted average concentrations with mkin +
  • @@ -96,8 +100,7 @@
    -

    -

    +

    Fit one or more kinetic models with one or more state variables to one or more datasets

    @@ -105,37 +108,38 @@ specified in its first two arguments.

    - 
    mmkin(models, datasets,
+    
    mmkin(models, datasets,
       cores = round(detectCores()/2), cluster = NULL, ...)
    
     
     
     Arguments
    
-    
    
-      
    models
    
-      
    
-    Either a character vector of shorthand names ("SFO", "FOMC", "DFOP",
-    "HS", "SFORB"), or an optionally named list of mkinmod
-    objects.
-  
    
-      
    datasets
    
-      
    
-    An optionally named list of datasets suitable as observed data for
-    mkinfit.
-  
    
-      
    cores
    
-      
    
-    The number of cores to be used for multicore processing. This is only
-    used when the cluster argument is NULL.
-  
    
-      
    cluster
    
-      
    
-    A cluster as returned by makeCluster to be used for parallel
-    execution.
-  
    
-      
    …
    
-      
    
-    Further arguments that will be passed to mkinfit.
-  
    
-    
    
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
    models
    Either a character vector of shorthand names ("SFO", "FOMC", "DFOP",
+    "HS", "SFORB"), or an optionally named list of mkinmod
+    objects.
    datasets
    An optionally named list of datasets suitable as observed data for
+    mkinfit.
    cores
    The number of cores to be used for multicore processing. This is only
+    used when the cluster argument is NULL.
    cluster
    A cluster as returned by makeCluster to be used for parallel
+    execution.
    …
    Further arguments that will be passed to mkinfit.
    
     
     
    Value
    
 
@@ -144,7 +148,7 @@
     
     
    See also
    
 
-    
    [.mmkin for subsetting, plot.mmkin for plotting.
    
+    
    [.mmkin for subsetting, plot.mmkin for plotting.
    
     
 
     
    Examples
    
@@ -160,11 +164,12 @@
 names(datasets) <- paste("Dataset", 1:3)
 
 time_default <- system.time(fits.0 <- mmkin(models, datasets, quiet = TRUE))
-time_1 <- system.time(fits.4 <- mmkin(models, datasets, cores = 1, quiet = TRUE))
-
+time_1 <- system.time(fits.4 <- mmkin(models, datasets, cores = 1, quiet = TRUE))
    #> Warning: Optimisation by method Port did not converge. +#> Convergence code is 1
    #> Warning: Optimisation by method Port did not converge. +#> Convergence code is 1
    time_default
    #> user system elapsed -#> 16.360 0.128 9.017
    time_1
    #> user system elapsed -#> 21.888 0.004 21.892
    +#> 16.092 0.132 11.761
    time_1
    #> user system elapsed +#> 25.004 0.000 25.000
    endpoints(fits.0[["SFO_lin", 2]])
    #> $ff #> parent_M1 parent_sink M1_M2 M1_sink #> 0.7340479 0.2659521 0.7505687 0.2494313 @@ -174,17 +179,17 @@ #> #> $distimes #> DT50 DT90 -#> parent 0.8777688 2.915885 +#> parent 0.8777689 2.915885 #> M1 2.3257456 7.725960 -#> M2 33.7200881 112.015708 +#> M2 33.7200862 112.015702 #>
    # plot.mkinfit handles rows or columns of mmkin result objects -plot(fits.0[1, ])
    plot(fits.0[1, ], obs_var = c("M1", "M2"))
    plot(fits.0[, 1])
    # Use double brackets to extract a single mkinfit object, which will be plotted +plot(fits.0[1, ])
    plot(fits.0[1, ], obs_var = c("M1", "M2"))
    plot(fits.0[, 1])
    # Use double brackets to extract a single mkinfit object, which will be plotted # by plot.mkinfit and can be plotted using plot_sep -plot(fits.0[[1, 1]], sep_obs = TRUE, show_residuals = TRUE, show_errmin = TRUE)
    plot_sep(fits.0[[1, 1]]) +plot(fits.0[[1, 1]], sep_obs = TRUE, show_residuals = TRUE, show_errmin = TRUE)
    plot_sep(fits.0[[1, 1]]) # Plotting with mmkin (single brackets, extracting an mmkin object) does not # allow to plot the observed variables separately -plot(fits.0[1, 1])
    +plot(fits.0[1, 1])