From 48601c14e2cac073af2e8eac57db41bfcb0032c4 Mon Sep 17 00:00:00 2001
From: Jordan Mark Barbone <38573843+jmbarbone@users.noreply.github.com>
Date: Tue, 26 Oct 2021 14:14:12 -0400
Subject: [PATCH] 50 prevents `factor` to `fact` in `details()` (#51)

* rewsolves #50

* changes argument order

* corrects use of factor_n

* syntax typo
---
 NEWS.md                      |  4 +++-
 R/detail.R                   | 29 +++++++++++++++++------------
 man/detail.Rd                |  8 ++++++--
 tests/testthat/test-detail.R |  5 +++++
 4 files changed, 31 insertions(+), 15 deletions(-)

diff --git a/NEWS.md b/NEWS.md
index 7147b2fd..9584311e 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -1,5 +1,7 @@
 # mark (development version)
 
+* `details(factor)` no longer adds `fact` class to `factors` [#50](https://github.com/jmbarbone/mark/issues/50)
+* `details()` gains new argument `factor_n` to control threshold for making character vectors into factors
 * `detail.data.frame()` now works with single column data.frames [#48](https://github.com/jmbarbone/mark/issues/48)
 
 # mark 0.4.0
@@ -26,7 +28,7 @@
 * `import(, overwrite = TRUE)` now works
 * `ls_function()`, `ls_object()`, `ls_dataframe()`, and `ls_all()` have improvements for environmental searching
 * `assign_labels.data.frame(.missing = "warning")` correctly removes missing columns
-* `remove_na.factor()` no long drops additional classes other than `ordered` and `factor` 
+* `remove_na.factor()` no long drops additional classes other than `ordered` and `factor`
 
 ## Others
 
diff --git a/R/detail.R b/R/detail.R
index 78bc17fc..1b02a242 100644
--- a/R/detail.R
+++ b/R/detail.R
@@ -22,8 +22,11 @@ detail <- function(x, ...) {
 }
 
 #' @rdname detail
+#' @param factor_n An `integer` threshold for making factors; will convert any
+#'   character vectors with `factor_n` or less unique values into a `fact`;
+#'   setting as `NA` will ignore this
 #' @export
-detail.default <- function(x, ...) {
+detail.default <- function(x, factor_n = 5L, ...) {
   stopifnot(!is.list(x))
 
   op <- options(stringsAsFactors = FALSE)
@@ -32,19 +35,21 @@ detail.default <- function(x, ...) {
   nas <- is.na(x)
   x2 <- x[!nas]
 
-  # If either of these exact, make as factor
-  has_lls <-
-    !is.null(attr(x, "levels", exact = TRUE)) ||
-    !is.null(attr(x, "labels", exact = TRUE))
-
-  if (has_lls) {
-    x <- fact(x)
-  }
-
   facts <- is.factor(x)
   quants <- !is.character(x) && !facts
   nc <- nchar(as.character(x))
 
+  if (!is.na(factor_n) && !facts) {
+    # If either of these exist, make as factor
+    has_lls <-
+      !is.null(attr(x, "levels", exact = TRUE)) ||
+      !is.null(attr(x, "labels", exact = TRUE))
+
+    if (has_lls) {
+      x <- fact(x)
+    }
+  }
+
   if (!facts & !quants) {
     if (length(unique(x)) <= 5) {
       x <- fact(x)
@@ -80,7 +85,7 @@ detail.default <- function(x, ...) {
 
 #' @rdname detail
 #' @export
-detail.data.frame <- function(x, ...) {
+detail.data.frame <- function(x, factor_n = 5L, ...) {
   op <- options(stringsAsFactors = FALSE)
   on.exit(options(op), add = TRUE)
 
@@ -91,7 +96,7 @@ detail.data.frame <- function(x, ...) {
     stop("x does not have any non-list columns", call. = FALSE)
   }
 
-  details <- lapply(x, detail)
+  details <- lapply(x, detail, factor_n = factor_n)
   reps <- vap_int(details, nrow)
 
   cbind(
diff --git a/man/detail.Rd b/man/detail.Rd
index 3e3a1e0b..fc0f5af0 100644
--- a/man/detail.Rd
+++ b/man/detail.Rd
@@ -8,14 +8,18 @@
 \usage{
 detail(x, ...)
 
-\method{detail}{default}(x, ...)
+\method{detail}{default}(x, factor_n = 5L, ...)
 
-\method{detail}{data.frame}(x, ...)
+\method{detail}{data.frame}(x, factor_n = 5L, ...)
 }
 \arguments{
 \item{x}{An object}
 
 \item{...}{Additional arguments passed to methods}
+
+\item{factor_n}{An \code{integer} threshold for making factors; will convert any
+character vectors with \code{factor_n} or less unique values into a \code{fact};
+setting as \code{NA} will ignore this}
 }
 \description{
 Provides details about an object
diff --git a/tests/testthat/test-detail.R b/tests/testthat/test-detail.R
index c804f271..781a27c2 100644
--- a/tests/testthat/test-detail.R
+++ b/tests/testthat/test-detail.R
@@ -10,6 +10,11 @@ test_that("details() works", {
   expect_error(detail(data.frame()))
 })
 
+test_that("details() keeps factors [50]", {
+  expect_identical(detail(factor("a"))$class, "factor")
+  expect_identical(detail(ordered("a"))$class, "ordered; factor")
+})
+
 test_that("details() and tibbles", {
   skip_if_not_installed("tibble")