From 2bb59c88d49b193f278916ad9cc4de83c0de9604 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 2 Mar 2022 18:03:54 +0100 Subject: Make tests more platform independent, update docs --- docs/reference/tffm0.html | 165 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 165 insertions(+) create mode 100644 docs/reference/tffm0.html (limited to 'docs/reference/tffm0.html') diff --git a/docs/reference/tffm0.html b/docs/reference/tffm0.html new file mode 100644 index 00000000..bc033fb3 --- /dev/null +++ b/docs/reference/tffm0.html @@ -0,0 +1,165 @@ + +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 + +
+ +
+

This transformation was used originally in mkin, in order to implement a +constraint for the sum of formation fractions to be smaller than 1. It 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 +the nlmixr modelling language, the original 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, 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

+
+
+

Details

+

If the transformed formation fractions are restricted to the interval +between 0 and 1, the sum of backtransformed values is restricted +to this interval.

+
+ +
+

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