From e05656d57668688b971c28e32b4cfd4d3eac4662 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 18 Sep 2019 13:03:50 +0200 Subject: Correct and rebuild docs - Reconcile docs and code for max_twa_parent - Correct links to docs in twa vignette - Static documentation rebuilt by pkgdown --- docs/reference/max_twa_parent.html | 67 ++++++++++++++++++++++++++++++++++---- 1 file changed, 60 insertions(+), 7 deletions(-) (limited to 'docs/reference/max_twa_parent.html') diff --git a/docs/reference/max_twa_parent.html b/docs/reference/max_twa_parent.html index 596e51ec..d1c2a805 100644 --- a/docs/reference/max_twa_parent.html +++ b/docs/reference/max_twa_parent.html @@ -16,13 +16,15 @@ - + + - - + + + @@ -51,6 +53,7 @@ guidance." /> + @@ -120,6 +123,7 @@ guidance." /> +

@@ -140,7 +144,11 @@ guidance.

max_twa_parent(fit, windows)

max_twa_parent(fit, windows)
+  max_twa_sfo(M0 = 1, k, t)
+  max_twa_fomc(M0 = 1, alpha, beta, t)
+  max_twa_dfop(M0 = 1, k1, k2, g, t)
+  max_twa_hs(M0 = 1, k1, k2, tb, t)

Arguments

@@ -153,11 +161,52 @@ guidance.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

windows	The width of the time windows for which the TWAs should be calculated.
M0	The initial concentration for which the maximum time weighted + average over the decline curve should be calculated. The default + is to use a value of 1, which means that a relative maximum time + weighted average factor (f_twa) is calculated.
k	The rate constant in the case of SFO kinetics.
t	The width of the time window.
alpha	Parameter of the FOMC model.
beta	Parameter of the FOMC model.
k1	The first rate constant of the DFOP or the HS kinetics.
k2	The second rate constant of the DFOP or the HS kinetics.
g	Parameter of the DFOP model.
tb	Parameter of the HS model.

Value

A numeric vector, named using the windows argument.

For max_twa_parent, a numeric vector, named using the windows argument. + For the other functions, a numeric vector of length one (also known as 'a + number').

References

@@ -170,7 +219,7 @@ guidance.

Examples

  fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
-  max_twa_parent(fit, c(7, 21))
#>        7       21 
+  max_twa_parent(fit, c(7, 21))
#>        7       21 
 #> 34.71343 18.22124

+ + + -- cgit v1.2.1