From 0799d692afb79e479f3c93d55f35a74ed7ab5683 Mon Sep 17 00:00:00 2001 From: Daniel Date: Wed, 18 Sep 2024 14:20:41 +0200 Subject: [PATCH] docs --- R/check_dag.R | 6 +++--- man/check_dag.Rd | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/check_dag.R b/R/check_dag.R index 7cdb7f4a5..2d7bdb42b 100644 --- a/R/check_dag.R +++ b/R/check_dag.R @@ -31,9 +31,9 @@ #' should be checked. Must be a valid name from the formulas provided in `...`. #' If not set, the first independent variable from the formulas is used. #' @param adjusted A character vector or formula with names of variables that -#' are adjusted for in the model. If a model object is provided in `...`, any -#' values in `adjusted` will be overwritten by the model's independent -#' variables. +#' are adjusted for in the model, e.g. `adjusted = c("x1", "x2")` or +#' `adjusted = ~ x1 + x2`. If a model object is provided in `...`, any values in +#' `adjusted` will be overwritten by the model's independent variables. #' @param latent A character vector with names of latent variables in the model. #' @param effect Character string, indicating which effect to check. Can be #' `"all"` (default), `"total"`, or `"direct"`. diff --git a/man/check_dag.Rd b/man/check_dag.Rd index a6e2c0ea3..f7c74ee18 100644 --- a/man/check_dag.Rd +++ b/man/check_dag.Rd @@ -33,9 +33,9 @@ should be checked. Must be a valid name from the formulas provided in \code{...} If not set, the first independent variable from the formulas is used.} \item{adjusted}{A character vector or formula with names of variables that -are adjusted for in the model. If a model object is provided in \code{...}, any -values in \code{adjusted} will be overwritten by the model's independent -variables.} +are adjusted for in the model, e.g. \code{adjusted = c("x1", "x2")} or +\code{adjusted = ~ x1 + x2}. If a model object is provided in \code{...}, any values in +\code{adjusted} will be overwritten by the model's independent variables.} \item{latent}{A character vector with names of latent variables in the model.}