From 2bb59c88d49b193f278916ad9cc4de83c0de9604 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 2 Mar 2022 18:03:54 +0100 Subject: Make tests more platform independent, update docs --- docs/reference/create_deg_func.html | 215 +++++++++++++----------------------- 1 file changed, 77 insertions(+), 138 deletions(-) (limited to 'docs/reference/create_deg_func.html') diff --git a/docs/reference/create_deg_func.html b/docs/reference/create_deg_func.html index 82583f1a..ca57addf 100644 --- a/docs/reference/create_deg_func.html +++ b/docs/reference/create_deg_func.html @@ -1,67 +1,12 @@ - - - - - - - -Create degradation functions for known analytical solutions — create_deg_func • mkin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create degradation functions for known analytical solutions — create_deg_func • mkin - - + + - - -
-
- -
- -
+

Create degradation functions for known analytical solutions

- Source: R/create_deg_func.R + Source: R/create_deg_func.R
@@ -147,83 +86,83 @@

Create degradation functions for known analytical solutions

- 
create_deg_func(spec, use_of_ff = c("min", "max"))
- -

Arguments

- - - - - - - - - - -
spec

List of model specifications as contained in mkinmod objects

use_of_ff

Minimum or maximum use of formation fractions

- -

Value

+
+ 
create_deg_func(spec, use_of_ff = c("min", "max"))
+
+
+

Arguments

+
spec
+

List of model specifications as contained in mkinmod objects

+
use_of_ff
+

Minimum or maximum use of formation fractions

+
+
+

Value

Degradation function to be attached to mkinmod objects

+
-

Examples

- 

-SFO_SFO <- mkinmod(
-  parent = mkinsub("SFO", "m1"),
-  m1 = mkinsub("SFO"))
-
#> Temporary DLL for differentials generated and loaded
FOCUS_D <- subset(FOCUS_2006_D, value != 0) # to avoid warnings
-fit_1 <- mkinfit(SFO_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE)
-fit_2 <- mkinfit(SFO_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE)
-# \dontrun{
-if (require(rbenchmark))
-  benchmark(
-    analytical = mkinfit(SFO_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE),
-    deSolve = mkinfit(SFO_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE),
-    replications = 2)
-
#> Loading required package: rbenchmark
#>         test replications elapsed relative user.self sys.self user.child
-#> 1 analytical            2   0.389    1.000     0.389        0          0
-#> 2    deSolve            2   0.690    1.774     0.690        0          0
-#>   sys.child
-#> 1         0
-#> 2         0
  DFOP_SFO <- mkinmod(
-    parent = mkinsub("DFOP", "m1"),
-    m1 = mkinsub("SFO"))
-
#> Temporary DLL for differentials generated and loaded
  benchmark(
-    analytical = mkinfit(DFOP_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE),
-    deSolve = mkinfit(DFOP_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE),
-    replications = 2)
-
#>         test replications elapsed relative user.self sys.self user.child
-#> 1 analytical            2   0.817    1.000     0.818        0          0
-#> 2    deSolve            2   1.591    1.947     1.591        0          0
-#>   sys.child
-#> 1         0
-#> 2         0
# }
-
+
+

Examples

+ 

+SFO_SFO <- mkinmod(
+  parent = mkinsub("SFO", "m1"),
+  m1 = mkinsub("SFO"))
+#> Temporary DLL for differentials generated and loaded
+FOCUS_D <- subset(FOCUS_2006_D, value != 0) # to avoid warnings
+fit_1 <- mkinfit(SFO_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE)
+fit_2 <- mkinfit(SFO_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE)
+# \dontrun{
+if (require(rbenchmark))
+  benchmark(
+    analytical = mkinfit(SFO_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE),
+    deSolve = mkinfit(SFO_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE),
+    replications = 2)
+#> Loading required package: rbenchmark
+#>         test replications elapsed relative user.self sys.self user.child
+#> 1 analytical            2   0.446    1.000     0.446        0          0
+#> 2    deSolve            2   0.756    1.695     0.756        0          0
+#>   sys.child
+#> 1         0
+#> 2         0
+  DFOP_SFO <- mkinmod(
+    parent = mkinsub("DFOP", "m1"),
+    m1 = mkinsub("SFO"))
+#> Temporary DLL for differentials generated and loaded
+  benchmark(
+    analytical = mkinfit(DFOP_SFO, FOCUS_D, solution_type = "analytical", quiet = TRUE),
+    deSolve = mkinfit(DFOP_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE),
+    replications = 2)
+#>         test replications elapsed relative user.self sys.self user.child
+#> 1 analytical            2   0.896    1.000     0.896        0          0
+#> 2    deSolve            2   1.685    1.881     1.685        0          0
+#>   sys.child
+#> 1         0
+#> 2         0
+# }
+
+
+
- - - + + -- cgit v1.2.1