From 23e27672ee9b8d42b618a49ea4f89586e65afad3 Mon Sep 17 00:00:00 2001
From: Daniel Sjoberg <danield.sjoberg@gmail.com>
Date: Fri, 1 Nov 2024 17:24:15 -0700
Subject: [PATCH] doc update

---
 R/ard_survival_survfit.R    | 7 +++++++
 man/ard_survival_survfit.Rd | 9 +++++++++
 2 files changed, 16 insertions(+)

diff --git a/R/ard_survival_survfit.R b/R/ard_survival_survfit.R
index 0ae89cd8..834e87a2 100644
--- a/R/ard_survival_survfit.R
+++ b/R/ard_survival_survfit.R
@@ -52,6 +52,13 @@
 #' ```
 #' You **cannot**, however, pass a stored formula, e.g. `survfit(my_formula, lung)`
 #'
+#' @section Variable Classes:
+#' When the `survfit` method is called, the class of the stratifying variables
+#' will be returned as a factor.
+#'
+#' When the data frame method is called, the original classes are retained in the
+#' resulting ARD.
+#'
 #' @return an ARD data frame of class 'card'
 #' @name ard_survival_survfit
 #'
diff --git a/man/ard_survival_survfit.Rd b/man/ard_survival_survfit.Rd
index 0d68a851..3f00bb00 100644
--- a/man/ard_survival_survfit.Rd
+++ b/man/ard_survival_survfit.Rd
@@ -89,6 +89,15 @@ lung |>
 You \strong{cannot}, however, pass a stored formula, e.g. \code{survfit(my_formula, lung)}
 }
 
+\section{Variable Classes}{
+
+When the \code{survfit} method is called, the class of the stratifying variables
+will be returned as a factor.
+
+When the data frame method is called, the original classes are retained in the
+resulting ARD.
+}
+
 \examples{
 \dontshow{if (do.call(asNamespace("cardx")$is_pkg_installed, list(pkg = c("survival", "broom", "ggsurvfit")))) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf}
 library(survival)