From ef1f4792a6a91839c1f44e2b395e0001f94bebb0 Mon Sep 17 00:00:00 2001 From: venpopov Date: Wed, 7 Feb 2024 09:01:23 +0100 Subject: [PATCH] update links to sdm vignette --- R/bmm_model_sdmSimple.R | 4 +++- R/distributions.R | 2 +- R/helpers-parameters.R | 2 +- man/SDM.Rd | 1 + man/SDMdist.Rd | 4 ++-- man/c_parametrizations.Rd | 2 +- 6 files changed, 9 insertions(+), 6 deletions(-) diff --git a/R/bmm_model_sdmSimple.R b/R/bmm_model_sdmSimple.R index b44a321e..30bfccd6 100644 --- a/R/bmm_model_sdmSimple.R +++ b/R/bmm_model_sdmSimple.R @@ -28,7 +28,9 @@ # automatically based on the information in the .model_sdmSimple()$info #' @title `r .model_sdmSimple()$info$name` #' @name SDM -#' @details `r model_info(sdmSimple())` +#' @details +#' see [vignette("sdm-simple")] for a detailed description of the model and how to use it. +#' `r model_info(sdmSimple())` #' @param ... used internally for testing, ignore it #' @return An object of class `bmmmodel` #' @export diff --git a/R/distributions.R b/R/distributions.R index 06943664..6c84f14d 100644 --- a/R/distributions.R +++ b/R/distributions.R @@ -16,7 +16,7 @@ #' @param kappa Vector of precision values #' @param log Logical; if `TRUE`, values are returned on the log scale. #' @param parametrization Character; either `"bessel"` or `"sqrtexp"` -#' (default). See `vignette("bmm_models")` for details on the +#' (default). See `vignette("sdm-simple")` for details on the #' parameterization. #' @param log.p Logical; if `TRUE`, probabilities are returned on the log #' scale. diff --git a/R/helpers-parameters.R b/R/helpers-parameters.R index eaba1f38..62009d69 100644 --- a/R/helpers-parameters.R +++ b/R/helpers-parameters.R @@ -42,7 +42,7 @@ k2sd <- function (K) { #' `c_sqrtexp2bessel` converts from the sqrtexp parametrization to the #' bessel parametrization. #' @keywords transform -#' @details See `vignette("bmm_models")` for details on the +#' @details See `vignette("sdm-simple")` for details on the #' parameterization. The sqrtexp parametrization is the default in the #' `bmm` package. #' @export diff --git a/man/SDM.Rd b/man/SDM.Rd index efa6ccb8..31cdf89b 100644 --- a/man/SDM.Rd +++ b/man/SDM.Rd @@ -17,6 +17,7 @@ An object of class \code{bmmmodel} Signal Discrimination Model (SDM) by Oberauer (2023) } \details{ +see \link{vignette("sdm-simple")} for a detailed description of the model and how to use it. \itemize{ \item \strong{Domain:} Visual working memory \item \strong{Task:} Continuous reproduction diff --git a/man/SDMdist.Rd b/man/SDMdist.Rd index 741b8c5f..f606d79d 100644 --- a/man/SDMdist.Rd +++ b/man/SDMdist.Rd @@ -37,7 +37,7 @@ rsdm(n, mu = 0, c = 3, kappa = 3.5, parametrization = "sqrtexp") \item{log}{Logical; if \code{TRUE}, values are returned on the log scale.} \item{parametrization}{Character; either \code{"bessel"} or \code{"sqrtexp"} -(default). See \code{vignette("bmm_models")} for details on the +(default). See \code{vignette("sdm-simple")} for details on the parameterization.} \item{q}{Vector of quantiles} @@ -70,7 +70,7 @@ single activation source is supported. \details{ \strong{Parametrization} -See \code{vignette("bmm_models")} for details on the parameterization. +See \code{vignette("sdm-simple")} for details on the parameterization. Oberauer (2023) introduced the SDM with the bessel parametrization. The sqrtexp parametrization is the default in the \code{bmm} package for numerical stability and efficiency. The two parametrizations are related by diff --git a/man/c_parametrizations.Rd b/man/c_parametrizations.Rd index 8e33cbb2..f0dad56b 100644 --- a/man/c_parametrizations.Rd +++ b/man/c_parametrizations.Rd @@ -25,7 +25,7 @@ bessel parametrization. Convert between parametrizations of the c parameter of the SDM distribution } \details{ -See \code{vignette("bmm_models")} for details on the +See \code{vignette("sdm-simple")} for details on the parameterization. The sqrtexp parametrization is the default in the \code{bmm} package. }