From 6ee791944a6270c8411454d2baa1654eb177e2e7 Mon Sep 17 00:00:00 2001
From: Sam Firke <sfirke@users.noreply.github.com>
Date: Wed, 4 Dec 2024 14:31:17 -0500
Subject: [PATCH] docs(tabyl): clarify / correct what var2 and var3 do (#586)

clarify / correct what these vars do
---
 R/tabyl.R    | 4 ++--
 man/tabyl.Rd | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/R/tabyl.R b/R/tabyl.R
index fca82750..9e534473 100644
--- a/R/tabyl.R
+++ b/R/tabyl.R
@@ -15,9 +15,9 @@
 #'   Or, a vector you want to tabulate.
 #' @param var1 The column name of the first variable.
 #' @param var2 (optional) the column name of the second variable
-#'   (the rows in a 2-way tabulation).
+#'   (its values become the column names in a 2-way tabulation).
 #' @param var3 (optional) the column name of the third variable
-#'   (the list in a 3-way tabulation).
+#'   (a 3-way tabulation is split into a list on its values).
 #' @param show_na Should counts of `NA` values be displayed?  In a one-way tabyl,
 #'   the presence of `NA` values triggers an additional column showing valid percentages
 #'   (calculated excluding `NA` values).
diff --git a/man/tabyl.Rd b/man/tabyl.Rd
index f883dd98..9b4569fe 100644
--- a/man/tabyl.Rd
+++ b/man/tabyl.Rd
@@ -29,10 +29,10 @@ output dimensions even when certain factor levels may not be present in the data
 \item{var1}{The column name of the first variable.}
 
 \item{var2}{(optional) the column name of the second variable
-(the rows in a 2-way tabulation).}
+(its values become the column names in a 2-way tabulation).}
 
 \item{var3}{(optional) the column name of the third variable
-(the list in a 3-way tabulation).}
+(a 3-way tabulation is split into a list on its values).}
 }
 \value{
 A \code{data.frame} with frequencies and percentages of the tabulated variable(s).