Solves issue #559

DESCRIPTION

@@ -58,7 +58,7 @@ SystemRequirements: Rendering the document template requires
   such as TinyTeX (>= 0.12; https://yihui.org/tinytex/)
 License: MIT + file LICENSE
 Encoding: UTF-8
-RoxygenNote: 7.2.2
+RoxygenNote: 7.2.3
 VignetteBuilder: knitr, R.rsp
 Language: en-US
 Roxygen: list(markdown = TRUE)

R/apa_num.R

@@ -430,12 +430,13 @@ print_p <- apa_p
 #'   should be determined for each element of `x` separately (the default),
 #'   or for the complete vector `x`.
 #' @inherit apa_num return
+#' @inheritParams base::formatC
 #' @seealso [apa_num()], [apa_p()]
 #' @examples
 #' apa_df(c(1, 1.23151))
 #' @export
 
-apa_df <- function(x, digits = 2L, elementwise = TRUE) {
+apa_df <- function(x, digits = 2L, big.mark = "", elementwise = TRUE) {
 
   if(is.null(x))    return(NULL)
   if(is.integer(x)) return(apa_num(x))
@@ -455,7 +456,7 @@ apa_df <- function(x, digits = 2L, elementwise = TRUE) {
     digits <- 0L
   }
 
-  apa_num(x, digits = digits)
+  apa_num(x, digits = digits, big.mark = big.mark)
 }
 
 #' @rdname apa_df

inst/NEWS.md

@@ -1,6 +1,6 @@
 # papaja 0.1.1
 
-- Maintenance update: Adjuted unit tests to avoid removal from CRAN
+- Maintenance update: Adjusted unit tests to avoid removal from CRAN
 
 # papaja 0.1.0
 

tests/testthat/test_apa_num.R

@@ -268,3 +268,19 @@ test_that(
     )
   }
 )
+
+test_that(
+  "apa_df() respects big.mark"
+  , {
+    # default
+    expect_identical(
+      apa_df(1e4)
+      , "10000"
+    )
+    # with other argument
+    expect_identical(
+      apa_df(1e4, big.mark = "{,}")
+      , "10{,}000"
+    )
+  }
+)