From 35adc7295c7f776f6219f0720be94e3d2ba085c1 Mon Sep 17 00:00:00 2001 From: "alex.hill@gmail.com" Date: Tue, 15 Oct 2024 12:22:22 +0100 Subject: [PATCH] update docs --- man/add_exposure_data.Rd | 2 +- man/biokinetics.Rd | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/man/add_exposure_data.Rd b/man/add_exposure_data.Rd index a2b744a..6c603ef 100644 --- a/man/add_exposure_data.Rd +++ b/man/add_exposure_data.Rd @@ -11,7 +11,7 @@ add_exposure_data(dat_sero, dat_inf, exposure_column = "day") \item{dat_inf}{data.table containing exposure days and person ids corresponding to those in dat_sero. By default the exposure days are expected in a column called 'day'.} -\item{exposure_column.}{Default 'day'. The name of the column containing exposure days. These can be integers or dates.} +\item{exposure_column}{Default 'day'. The name of the column containing exposure days. These can be integers or dates.} } \value{ A data.table with all columns required by the biokinetics model. diff --git a/man/biokinetics.Rd b/man/biokinetics.Rd index ce378fe..4a1c7a3 100644 --- a/man/biokinetics.Rd +++ b/man/biokinetics.Rd @@ -222,14 +222,14 @@ Default TRUE.} \item{\code{n_draws}}{Integer. Maximum number of samples to draw. Default 2500.} -\item{\code{time_shift}}{Integer. Number of days to adjust the exposure date by. Default 0.} +\item{\code{time_shift}}{Integer. Number of days to adjust the exposure day by. Default 0.} } \if{html}{\out{}} } \subsection{Returns}{ A data.table. If summarise = TRUE columns are calendar_date, titre_type, me, lo, hi, time_shift. -If summarise = FALSE, columns are pid, draw, t, mu, titre_type, exposure_date, calendar_date, time_shift -and a column for each covariate in the hierarchical model. See the data vignette for details: +If summarise = FALSE, columns are pid, draw, time_since_last_exp, mu, titre_type, exposure_day, calendar_day, time_shift +and a column for each covariate in the regression model. See the data vignette for details: \code{vignette("data", package = "epikinetics")}. } }