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/mean_degparms.html | 134 ++++++++++++++++++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 docs/dev/reference/mean_degparms.html (limited to 'docs/dev/reference/mean_degparms.html') diff --git a/docs/dev/reference/mean_degparms.html b/docs/dev/reference/mean_degparms.html new file mode 100644 index 00000000..41517875 --- /dev/null +++ b/docs/dev/reference/mean_degparms.html @@ -0,0 +1,134 @@ + +Calculate mean degradation parameters for an mmkin row object — mean_degparms • mkin + Skip to contents + + +
+
+
+ +

Calculate mean degradation parameters for an mmkin row object

+ Source: R/mean_degparms.R +
mean_degparms.Rd
+
+ +
+

Calculate mean degradation parameters for an mmkin row object

+
+ +
+

Usage

+ 
mean_degparms(
+  object,
+  random = FALSE,
+  test_log_parms = FALSE,
+  conf.level = 0.6,
+  default_log_parms = NA
+)
+
+ +
+

Arguments

+ + +
object
+

An mmkin row object containing several fits of the same model to different datasets

+ + +
random
+

Should a list with fixed and random effects be returned?

+ + +
test_log_parms
+

If TRUE, log parameters are only considered in +the mean calculations if their untransformed counterparts (most likely +rate constants) pass the t-test for significant difference from zero.

+ + +
conf.level
+

Possibility to adjust the required confidence level +for parameter that are tested if requested by 'test_log_parms'.

+ + +
default_log_parms
+

If set to a numeric value, this is used +as a default value for the tested log parameters that failed the +t-test.

+ +
+
+

Value

+

If random is FALSE (default), a named vector containing mean values +of the fitted degradation model parameters. If random is TRUE, a list with +fixed and random effects, in the format required by the start argument of +nlme for the case of a single grouping variable ds.

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