From 6178249bbb5e9de7cb7f34287ee7de28a68fed6c Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 10 Aug 2022 15:38:17 +0200 Subject: Change dev branch used for docs, update static docs --- docs/dev/reference/create_deg_func.html | 228 ++++++++++++-------------------- 1 file changed, 86 insertions(+), 142 deletions(-) (limited to 'docs/dev/reference/create_deg_func.html') diff --git a/docs/dev/reference/create_deg_func.html b/docs/dev/reference/create_deg_func.html index 65a682bb..5d5870fe 100644 --- a/docs/dev/reference/create_deg_func.html +++ b/docs/dev/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,88 @@

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

- -

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.396     1.00     0.396        0          0
-#> 2    deSolve            2   0.709     1.79     0.707        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.844    1.000     0.844        0          0
-#> 2    deSolve            2   1.624    1.924     1.624        0          0
-#>   sys.child
-#> 1         0
-#> 2         0
# }
-
+
+ 
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)
+# \dontrun{
+fit_2 <- mkinfit(SFO_SFO, FOCUS_D, solution_type = "deSolve", quiet = TRUE)
+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.401    1.000     0.401        0          0
+#> 2    deSolve            2   0.654    1.631     0.654        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.843    1.000     0.843        0          0
+#> 2    deSolve            2   1.445    1.714     1.445        0          0
+#>   sys.child
+#> 1         0
+#> 2         0
+# }
+
+
+
- - - + + -- cgit v1.2.1