Document attribute "ratio" returned by counting_process()

Author: jdblischak

R/counting_process.R

@@ -40,7 +40,7 @@
 #'
 #' @return
 #' A data frame grouped by `stratum` and sorted within stratum by `tte`.
-#' Remain rows with at least one event in the population, at least one subject
+#' It only includes rows with at least one event in the population, at least one subject
 #' is at risk in both treatment group and control group.
 #' Other variables in this represent the following within each stratum at
 #' each time at which one or more events are observed:
@@ -62,12 +62,15 @@
 #' @export
 #'
 #' @details
-#' The output produced by [counting_process()] produces a
-#' counting process dataset grouped by stratum and sorted within stratum
-#' by increasing times where events occur. The object is assigned the class
-#' "counting_process". It also has the attributes "n_ctrl" and "n_exp",
-#' which are the totals of the control and experimental treatments,
-#' respectively, from the input time-to-event data.
+#' The output produced by [counting_process()] produces a counting process
+#' dataset grouped by stratum and sorted within stratum by increasing times
+#' where events occur. The object is assigned the class "counting_process". It
+#' also has the attribute "ratio", which is the ratio of the events in the
+#' treatment arm compared to the control arm in the input time-to-event data. If
+#' the input data was generated by [sim_pw_surv()], the ratio attribute is
+#' simply obtained from the attribute of the same name from the input object.
+#' Otherwise, the returned ratio is the empirical ratio of treatment to control
+#' events.
 #'
 #' @examples
 #' # Example 1
@@ -152,7 +155,7 @@ counting_process <- function(x, arm) {
   if ("generate_by_simpwsurv" %in% names(attributes(x))) {
     ratio <- attributes(x)$ratio
   } else {
-  # if not, calcualte the emperical ratio
+  # if not, calculate the empirical ratio
     ratio <- sum(x$treatment == arm) / sum(x$treatment != arm)
   }
   attr(ans, "ratio") <- ratio