aboutsummaryrefslogtreecommitdiff
path: root/R
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-01-18 22:41:01 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-01-18 22:50:14 +0100
commita76221d87485029444c8e684022ca606a0c7e68d (patch)
treec95052ee51b35f6c5ab87bd6f27ef2877f536838 /R
parenta1d9f93138c2cfed92a683e37e72c737d52b7ad7 (diff)
Update static docs using pkgdown
- Add _pkgdown.yml for a structured function/data reference - Make seealso links active - Make mkinfit calls quiet - Use pkgdown branch from pull request hadley/pkgdown#229 to have topics ordered
Diffstat (limited to 'R')
-rw-r--r--R/twa.R10
1 files changed, 5 insertions, 5 deletions
diff --git a/R/twa.R b/R/twa.R
index 3865fd7..e14318f 100644
--- a/R/twa.R
+++ b/R/twa.R
@@ -35,13 +35,13 @@
#'
#' # Use a fitted mkinfit model
#' require(mkin)
-#' fit <- mkinfit("FOMC", FOCUS_2006_C)
+#' fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
#' pred_1 <- one_box(fit)
#' plot(pred_1)
#'
#' # Use a model with more than one observed variable
#' m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
-#' fit_2 <- mkinfit(m_2, FOCUS_2006_D)
+#' fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
#' pred_2 <- one_box(fit_2)
#' plot(pred_2)
one_box <- function(x,
@@ -138,7 +138,7 @@ plot.one_box <- function(x,
#' plot(sawtooth(pred, applications = applications))
#'
#' m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
-#' fit_2 <- mkinfit(m_2, FOCUS_2006_D)
+#' fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
#' pred_2 <- one_box(fit_2)
#' pred_2_saw <- sawtooth(pred_2, 2, 7)
#' plot(pred_2_saw, max_twa = 21, max_twa_var = "m1")
@@ -178,7 +178,7 @@ sawtooth <- function(x, n = 1, i = 365,
#'
#' @param x An object of type \code{\link{one_box}}
#' @param window The size of the moving window
-#' @seealso max_twa
+#' @seealso \code{\link{max_twa}}
#' @export
#' @examples
#' pred <- sawtooth(one_box(10),
@@ -200,7 +200,7 @@ twa.one_box <- function(x, window = 21)
#' The maximum time weighted average concentration for a moving window
#'
-#' @seealso twa
+#' @seealso \code{\link{twa}}
#' @inheritParams twa
#' @export
max_twa <- function(x, window = 21) UseMethod("max_twa")

Contact - Imprint