From b3ca0aa552916b10a7d6d642138aecf744aed3de Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Mon, 28 Feb 2022 15:05:58 +0100 Subject: Update docs --- docs/dev/reference/mean_degparms.html | 155 +++++++++------------------------- 1 file changed, 40 insertions(+), 115 deletions(-) (limited to 'docs/dev/reference/mean_degparms.html') diff --git a/docs/dev/reference/mean_degparms.html b/docs/dev/reference/mean_degparms.html index 5981c625..d348fa74 100644 --- a/docs/dev/reference/mean_degparms.html +++ b/docs/dev/reference/mean_degparms.html @@ -1,67 +1,12 @@ - - - - - - - -Calculate mean degradation parameters for an mmkin row object — mean_degparms • mkin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Calculate mean degradation parameters for an mmkin row object — mean_degparms • mkin - - + + - - -
-
- -
- -
+

Calculate mean degradation parameters for an mmkin row object

- Source: R/mean_degparms.R + Source: R/mean_degparms.R
@@ -147,64 +83,53 @@

Calculate mean degradation parameters for an mmkin row object

- 
mean_degparms(object, random = FALSE, test_log_parms = FALSE, conf.level = 0.6)
- -

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'.

- -

Value

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

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'.

+
+
+

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