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/tffm0.html | 178 +++++++++++++----------------------------- 1 file changed, 55 insertions(+), 123 deletions(-) (limited to 'docs/dev/reference/tffm0.html') diff --git a/docs/dev/reference/tffm0.html b/docs/dev/reference/tffm0.html index c7b5b6de..8988b5a2 100644 --- a/docs/dev/reference/tffm0.html +++ b/docs/dev/reference/tffm0.html @@ -1,46 +1,5 @@ - - - - - - - -Transform formation fractions as in the first published mkin version — tffm0 • mkin - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Transform formation fractions as in the first published mkin version — tffm0 • mkin - - - - - - - - - - - - - + + -
-
- -
- -
+

Transform formation fractions as in the first published mkin version

- Source: R/tffm0.R + Source: R/tffm0.R

The transformed fractions can be restricted between 0 and 1 in model optimisations. Therefore this transformation was used originally in mkin. It -was later replaced by the ilr transformation because the ilr transformed +was later replaced by the ilr transformation because the ilr transformed fractions can assumed to follow normal distribution. As the ilr -transformation is not available in RxODE and can therefore not be used in +transformation is not available in RxODE and can therefore not be used in the nlmixr modelling language, this transformation is currently used for translating mkin models with formation fractions to more than one target -compartment for fitting with nlmixr in nlmixr_model. However, +compartment for fitting with nlmixr in nlmixr_model. However, this implementation cannot be used there, as it is not accessible from RxODE.

- 
tffm0(ff)
-
-invtffm0(ff_trans)
- -

Arguments

- - - - - - - - - - -
ff

Vector of untransformed formation fractions. The sum -must be smaller or equal to one

ff_trans

Vector of transformed formation fractions that can be -restricted to the interval from 0 to 1

- -

Value

- -

A vector of the transformed formation fractions

-

A vector of backtransformed formation fractions for natural use in degradation models

- -

Examples

- 
ff_example <- c(
-  0.10983681, 0.09035905, 0.08399383
-)
-ff_example_trans <- tffm0(ff_example)
-invtffm0(ff_example_trans)
-
#> [1] 0.10983681 0.09035905 0.08399383
+
+ 
tffm0(ff)
+
+invtffm0(ff_trans)
+
+ +
+

Arguments

+
ff
+

Vector of untransformed formation fractions. The sum +must be smaller or equal to one

+
ff_trans
+

Vector of transformed formation fractions that can be +restricted to the interval from 0 to 1

+
+
+

Value

+

A vector of the transformed formation fractions +A vector of backtransformed formation fractions for natural use in degradation models

+
+ +
+

Examples

+ 
ff_example <- c(
+  0.10983681, 0.09035905, 0.08399383
+)
+ff_example_trans <- tffm0(ff_example)
+invtffm0(ff_example_trans)
+#> [1] 0.10983681 0.09035905 0.08399383
+
+
+
-
- - + + -- cgit v1.2.1