From 91a5834dd701211f929fd25419dc34561ce3b4e7 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 14 Feb 2025 09:15:20 +0100 Subject: Initialize dev docs --- docs/dev/reference/update.mkinfit.html | 138 +++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 docs/dev/reference/update.mkinfit.html (limited to 'docs/dev/reference/update.mkinfit.html') diff --git a/docs/dev/reference/update.mkinfit.html b/docs/dev/reference/update.mkinfit.html new file mode 100644 index 00000000..e83fe3d2 --- /dev/null +++ b/docs/dev/reference/update.mkinfit.html @@ -0,0 +1,138 @@ + +Update an mkinfit model with different arguments — update.mkinfit • mkin + Skip to contents + + +
+
+
+ +

Update an mkinfit model with different arguments

+ Source: R/update.mkinfit.R +
update.mkinfit.Rd
+
+ +
+

This function will return an updated mkinfit object. The fitted degradation +model parameters from the old fit are used as starting values for the +updated fit. Values specified as 'parms.ini' and/or 'state.ini' will +override these starting values.

+
+ +
+

Usage

+ 
# S3 method for class 'mkinfit'
+update(object, ..., evaluate = TRUE)
+
+ +
+

Arguments

+ + +
object
+

An mkinfit object to be updated

+ + +
...
+

Arguments to mkinfit that should replace +the arguments from the original call. Arguments set to NULL will +remove arguments given in the original call

+ + +
evaluate
+

Should the call be evaluated or returned as a call

+ +
+ +
+

Examples

+ 
# \dontrun{
+fit <- mkinfit("SFO", subset(FOCUS_2006_D, value != 0), quiet = TRUE)
+parms(fit)
+#>    parent_0    k_parent       sigma 
+#> 99.44423885  0.09793574  3.39632469 
+plot_err(fit)
+
+fit_2 <- update(fit, error_model = "tc")
+parms(fit_2)
+#>     parent_0     k_parent    sigma_low     rsd_high 
+#> 1.008549e+02 1.005665e-01 3.752222e-03 6.763434e-02 
+plot_err(fit_2)
+
+# }
+
+
+
+ + +
+ + + + + + + -- cgit v1.2.1