From a0dc08a2961ea1b5404a1504fd6c567566bd18ea Mon Sep 17 00:00:00 2001 From: Zelos Zhu Date: Wed, 8 Nov 2023 18:48:26 +0000 Subject: [PATCH] chore: #2142 update documentation based on feedback --- R/derive_param_exposure.R | 7 +++---- man/derive_param_exposure.Rd | 11 ++++------- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/R/derive_param_exposure.R b/R/derive_param_exposure.R index 11552b94ed..8430aa7d89 100644 --- a/R/derive_param_exposure.R +++ b/R/derive_param_exposure.R @@ -4,13 +4,12 @@ #' start (`ASTDT(M)`)and end date (`AENDT(M)`) as the minimum and maximum date by `by_vars`. #' #' @param dataset -#' `r roxygen_param_dataset(expected_vars = c("by_vars", "analysis_var"))` -#' `PARAMCD` is expected as well, +#' `r roxygen_param_dataset(expected_vars = c("by_vars"))` #' #' @param dataset_add Additional dataset #' -#' The variables specified for `by_vars`, `analysis_var`, -#' + alongside either `ASTDTM` and `AENDTM` or `ASTDT` and `AENDT` are also expected. +#' The variables specified for `by_vars`, `analysis_var`, `PARAMCD`, +#' alongside either `ASTDTM` and `AENDTM` or `ASTDT` and `AENDT` are also expected. #' Observations from the specified dataset are going to be used to calculate and added #' as new records to the input dataset (`dataset`). #' diff --git a/man/derive_param_exposure.Rd b/man/derive_param_exposure.Rd index 9199ebd5d8..cea65120e1 100644 --- a/man/derive_param_exposure.Rd +++ b/man/derive_param_exposure.Rd @@ -19,17 +19,14 @@ derive_param_exposure( \arguments{ \item{dataset}{Input dataset -The variables specified by the \code{by_vars} and \code{analysis_var} argument(s) to be expected. -\code{PARAMCD} is expected as well,} +The variables specified by the \code{by_vars} argument(s) to be expected.} \item{dataset_add}{Additional dataset -The variables specified for \code{by_vars}, \code{analysis_var}, -\itemize{ -\item alongside either \code{ASTDTM} and \code{AENDTM} or \code{ASTDT} and \code{AENDT} are also expected. +The variables specified for \code{by_vars}, \code{analysis_var}, \code{PARAMCD}, +alongside either \code{ASTDTM} and \code{AENDTM} or \code{ASTDT} and \code{AENDT} are also expected. Observations from the specified dataset are going to be used to calculate and added -as new records to the input dataset (\code{dataset}). -}} +as new records to the input dataset (\code{dataset}).} \item{by_vars}{Grouping variables