doc: minor corrections to get_age_group documentation

epiverse-trace · Dec 15, 2023 · 94f0e5c · 94f0e5c
1 parent 0c22788
commit 94f0e5c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/R/seroprevalence_data.R b/R/seroprevalence_data.R
@@ -297,14 +297,14 @@ generate_sim_data <- function(foi,
 #'
 #' This function was taken from [get_age_group][vaccineff::get_age_group].
 #' This method splits an age interval from age_min to age_max into
-#' (age_max-age_min)/step intervals.
+#' `(age_max-age_min)/step` intervals.
 #' By default age_min is set 0, however it can be assigned by
 #' convenience.
 #' If the method finds ages greater or equal than age_max
-#' it assigns the string ">{age_max}".
-#' To avoid errors it is necessary to set step < age_max.
+#' it assigns the string `">{age_max}"`.
+#' To avoid errors it is necessary to set `step<age_max`.
 #' It is also suggested to choose the step such
-#' that age_max%%(step+1) = 0.
+#' that `age_max%%(step+1)=0`.
 #' @param age vector containing age information
 #' @param  step step used to split the age interval
 #' @return age_group factor variable grouping `age` by the age intervals

diff --git a/man/get_age_group.Rd b/man/get_age_group.Rd