Rename convertToExcelDate (#672)

* convertToExcelDate -> convert_to_excel_date * Update example * Fixed deprecation --------- Co-authored-by: Jan Marvin Garbuszus <jan.garbuszus@ruhr-uni-bochum.de>
JanMarvin · Jul 2, 2023 · 8d3ad5d · 8d3ad5d
1 parent 2b2267a
commit 8d3ad5d
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 6 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -13,6 +13,7 @@ export(convertToExcelDate)
 export(convert_date)
 export(convert_datetime)
 export(convert_hms)
+export(convert_to_excel_date)
 export(create_border)
 export(create_cell_style)
 export(create_comment)

diff --git a/R/dates.R b/R/dates.R
@@ -211,9 +211,9 @@ conv_to_excel_date <- function(x, date1904 = FALSE) {
 #'  wb1 <- wb_load(xlsxFile)
 #'  df <- wb_to_df(wb1)
 #'  # conversion is done on dataframes only
-#'  convertToExcelDate(df = df["Var5"], date1904 = FALSE)
+#'  convert_to_excel_date(df = df["Var5"], date1904 = FALSE)
 #' @export
-convertToExcelDate <- function(df, date1904 = FALSE) {
+convert_to_excel_date <- function(df, date1904 = FALSE) {
 
   is_date <- vapply(
     df,
@@ -227,3 +227,9 @@ convertToExcelDate <- function(df, date1904 = FALSE) {
 
   df
 }
+#' @export
+#' @rdname convert_to_excel_date
+convertToExcelDate <- function(df, date1904 = FALSE) {
+  .Deprecated(old = "convertToExcelDate", new = "convert_to_excel_date", package = "openxlsx2")
+  convert_to_excel_date(df = df, date1904 = date1904)
+}
diff --git a/R/write.R b/R/write.R
@@ -233,7 +233,7 @@ write_data2 <- function(
                              ignore.case = TRUE)
 
   # TODO need to tell excel that we have a date, apply some kind of numFmt
-  data <- convertToExcelDate(df = data, date1904 = hconvert_date1904)
+  data <- convert_to_excel_date(df = data, date1904 = hconvert_date1904)
 
   # backward compatible
   if (!inherits(data, "data.frame") || inherits(data, "matrix")) {

diff --git a/man/convertToExcelDate.Rd → man/convert_to_excel_date.Rd b/man/convertToExcelDate.Rd → man/convert_to_excel_date.Rd
diff --git a/tests/testthat/test-wb_functions.R b/tests/testthat/test-wb_functions.R
@@ -31,7 +31,7 @@ test_that("wb_to_df", {
 
   # do not try to identify dates in the data
   got <- wb_to_df(wb1, detectDates = FALSE)
-  expect_equal(convertToExcelDate(df = exp["Var5"], date1904 = FALSE),
+  expect_equal(convert_to_excel_date(df = exp["Var5"], date1904 = FALSE),
                got["Var5"])
 
   # return the underlying Excel formula instead of their values