clarified in docs that age is not used in calculation

ropensci · Sep 25, 2019 · 8dec24c · 8dec24c
1 parent 307e23f
commit 8dec24c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/R/convert.R b/R/convert.R
@@ -131,7 +131,8 @@ check_route <- function(x, route_label) {
 #' @family checking functions
 #' @examples
 #' participant_ID <- c("P01", "P02", "P03", "P04")
-#' age <- c(42, 29, 30, 60)
+#' age <- c(42, 29, 30, 60) # not used in calculation, just shows other data
+#'                          # can exist in the data.frame
 #' antipsychotic <- c("olanzapine", "olanzapine", "quetiapine", "ziprasidone")
 #' dose <- c(10, 12.5, 300, 60)
 #' example_oral <- data.frame(participant_ID, age, antipsychotic, dose, 
@@ -213,7 +214,8 @@ check_ap <- function(x, key=chlorpromazineR::gardner2010, ap_label, route,
 #' @family conversion functions
 #' @examples
 #' participant_ID <- c("P01", "P02", "P03", "P04")
-#' age <- c(42, 29, 30, 60)
+#' age <- c(42, 29, 30, 60) # not used in calculation, just shows other data
+#'                          # can exist in the data.frame
 #' antipsychotic <- c("olanzapine", "olanzapine", "quetiapine", "ziprasidone")
 #' dose <- c(10, 12.5, 300, 60)
 #' example_oral <- data.frame(participant_ID, age, antipsychotic, dose,

diff --git a/man/check_ap.Rd b/man/check_ap.Rd
diff --git a/man/to_ap.Rd b/man/to_ap.Rd