Rename some methods for consistency

NAMESPACE

@@ -34,6 +34,8 @@ export(assert_type)
 export(assert_unique)
 export(assert_whole)
 export(check_class)
+export(compact_cols)
+export(discard_cols)
 export(has_colnames)
 export(has_duplicates)
 export(has_infinite)
@@ -75,6 +77,7 @@ export(is_vector)
 export(is_warning)
 export(is_whole)
 export(is_zero)
+export(keep_cols)
 export(label_percent)
 export(needs)
 export(scale_midpoint)
@@ -87,7 +90,7 @@ exportMethods(assign_rownames)
 exportMethods(bootstrap)
 exportMethods(clean_whitespace)
 exportMethods(compact)
-exportMethods(compact_cols)
+exportMethods(compact_columns)
 exportMethods(compact_rows)
 exportMethods(confidence_binomial)
 exportMethods(confidence_mean)
@@ -96,15 +99,15 @@ exportMethods(count)
 exportMethods(describe)
 exportMethods(detect)
 exportMethods(discard)
-exportMethods(discard_cols)
+exportMethods(discard_columns)
 exportMethods(discard_rows)
 exportMethods(get_columns)
 exportMethods(get_rows)
 exportMethods(interval_credible)
 exportMethods(interval_hdr)
 exportMethods(jackknife)
 exportMethods(keep)
-exportMethods(keep_cols)
+exportMethods(keep_columns)
 exportMethods(keep_rows)
 exportMethods(math_gcd)
 exportMethods(math_lcm)

R/AllGenerics.R

@@ -64,10 +64,10 @@ setGeneric(
 )
 
 #' @rdname keep
-#' @aliases keep_cols-method
+#' @aliases keep_columns-method
 setGeneric(
-  name = "keep_cols",
-  def = function(x, ...) standardGeneric("keep_cols")
+  name = "keep_columns",
+  def = function(x, ...) standardGeneric("keep_columns")
 )
 
 #' @rdname keep
@@ -95,10 +95,10 @@ setGeneric(
 )
 
 #' @rdname discard
-#' @aliases discard_cols-method
+#' @aliases discard_columns-method
 setGeneric(
-  name = "discard_cols",
-  def = function(x, ...) standardGeneric("discard_cols")
+  name = "discard_columns",
+  def = function(x, ...) standardGeneric("discard_columns")
 )
 
 #' @rdname discard
@@ -130,10 +130,10 @@ setGeneric(
 )
 
 #' @rdname compact
-#' @aliases compact_cols-method
+#' @aliases compact_columns-method
 setGeneric(
-  name = "compact_cols",
-  def = function(x, ...) standardGeneric("compact_cols")
+  name = "compact_columns",
+  def = function(x, ...) standardGeneric("compact_columns")
 )
 
 #' @rdname compact

R/arkhe-deprecated.R

@@ -11,7 +11,28 @@ NULL
 
 #' @export
 #' @rdname arkhe-deprecated
-assert_dimensions <- function(x, expected) {
+assert_dimensions <- function(...) {
   # .Deprecated("assert_dim()", old = "assert_dimensions()")
-  assert_dim(x, expected)
+  assert_dim(...)
+}
+
+#' @export
+#' @rdname arkhe-deprecated
+compact_cols <- function(...) {
+  # .Deprecated("compact_columns()", old = "compact_cols()")
+  compact_columns(...)
+}
+
+#' @export
+#' @rdname arkhe-deprecated
+discard_cols <- function(...) {
+  # .Deprecated("discard_columns()", old = "discard_cols()")
+  discard_columns(...)
+}
+
+#' @export
+#' @rdname arkhe-deprecated
+keep_cols <- function(...) {
+  # .Deprecated("keep_columns()", old = "keep_cols()")
+  keep_columns(...)
 }

R/compact.R

@@ -24,9 +24,9 @@ setMethod(
 
 #' @export
 #' @rdname compact
-#' @aliases compact_cols,ANY-method
+#' @aliases compact_columns,ANY-method
 setMethod(
-  f = "compact_cols",
+  f = "compact_columns",
   signature = c(x = "ANY"),
   definition = function(x, na.rm = FALSE, verbose = getOption("arkhe.verbose")) {
     compact(x, margin = 2, na.rm = na.rm, verbose = verbose)

R/discard.R

@@ -36,9 +36,9 @@ setMethod(
 
 #' @export
 #' @rdname discard
-#' @aliases discard_cols,ANY-method
+#' @aliases discard_columns,ANY-method
 setMethod(
-  f = "discard_cols",
+  f = "discard_columns",
   signature = c(x = "ANY"),
   definition = function(x, f, negate = FALSE, all = FALSE, na.rm = FALSE,
                         verbose = getOption("arkhe.verbose"), ...) {

R/keep.R

@@ -36,9 +36,9 @@ setMethod(
 
 #' @export
 #' @rdname keep
-#' @aliases keep_cols,ANY-method
+#' @aliases keep_columns,ANY-method
 setMethod(
-  f = "keep_cols",
+  f = "keep_columns",
   signature = c(x = "ANY"),
   definition = function(x, f, negate = FALSE, all = FALSE, na.rm = FALSE,
                         verbose = getOption("arkhe.verbose"), ...) {

inst/tinytest/test_compact.R

@@ -16,7 +16,7 @@ expect_equal(nrow(clean_row), 4)
 expect_equal(ncol(clean_row), ncol(mtx0))
 
 ## Remove columns
-clean_col <- compact_cols(mtx0)
+clean_col <- compact_columns(mtx0)
 expect_equal(ncol(clean_col), 2)
 expect_equal(nrow(clean_col), nrow(mtx0))
 
@@ -38,7 +38,7 @@ expect_equal(nrow(clean_row), 4)
 expect_equal(ncol(clean_row), ncol(charBlank))
 
 ## Remove columns
-clean_col <- compact_cols(charBlank)
+clean_col <- compact_columns(charBlank)
 expect_equal(ncol(clean_col), 2)
 expect_equal(nrow(clean_col), nrow(charBlank))
 
@@ -51,7 +51,7 @@ bin <- matrix(c(FALSE, TRUE, TRUE, TRUE, FALSE,
 ## Nothing to remove
 clean <- compact_rows(bin)
 expect_equal(nrow(clean), 4)
-clean <- compact_cols(bin)
+clean <- compact_columns(bin)
 expect_equal(ncol(clean), 2)
 
 binNA <- bin
@@ -66,8 +66,8 @@ expect_equal(nrow(clean_row), 4)
 expect_equal(ncol(clean_row), ncol(binNA))
 
 ## Remove columns
-clean_col <- compact_cols(binNA) # Nothing to remove
+clean_col <- compact_columns(binNA) # Nothing to remove
 expect_equal(dim(clean_col), dim(binNA))
-clean_col <- compact_cols(binNA, na.rm = TRUE)
+clean_col <- compact_columns(binNA, na.rm = TRUE)
 expect_equal(ncol(clean_col), 2)
 expect_equal(nrow(clean_col), nrow(binNA))

inst/tinytest/test_discard.R

@@ -9,9 +9,9 @@ expect_message(discard_rows(mtx, f = is_zero, verbose = TRUE))
 mtx[1, ] <- 0 # Add zeros
 
 ## Nothing to remove
-clean <- discard_cols(mtx, f = is_zero, all = TRUE)
+clean <- discard_columns(mtx, f = is_zero, all = TRUE)
 expect_equal(dim(clean), dim(mtx))
-expect_message(discard_cols(mtx, f = is_zero, all = TRUE, verbose = TRUE))
+expect_message(discard_columns(mtx, f = is_zero, all = TRUE, verbose = TRUE))
 
 mtx[, 1] <- 0 # Add zeros
 
@@ -22,7 +22,7 @@ expect_equal(ncol(clean_row), ncol(mtx))
 expect_message(discard_rows(mtx, f = is_zero, all = TRUE, verbose = TRUE))
 
 ## Remove columns
-clean_col <- discard_cols(mtx, f = is_zero, all = TRUE)
+clean_col <- discard_columns(mtx, f = is_zero, all = TRUE)
 expect_equal(ncol(clean_col), ncol(mtx) - 1L)
 expect_equal(nrow(clean_col), nrow(mtx))
-expect_message(discard_cols(mtx, f = is_zero, all = TRUE, verbose = TRUE))
+expect_message(discard_columns(mtx, f = is_zero, all = TRUE, verbose = TRUE))

inst/tinytest/test_keep.R

@@ -8,7 +8,7 @@ expect_equal(dim(clean), c(0, 3))
 mtx[1, ] <- 0 # Add zeros
 
 # Nothing to keep
-clean <- keep_cols(mtx, f = is_zero, all = TRUE)
+clean <- keep_columns(mtx, f = is_zero, all = TRUE)
 expect_equal(dim(clean), c(5, 0))
 
 mtx[, 1] <- 0 # Add zeros
@@ -18,16 +18,16 @@ clean_row <- keep_rows(mtx, f = is_zero, all = FALSE)
 expect_equal(clean_row, mtx)
 expect_message(keep_rows(mtx, f = is_zero, verbose = TRUE))
 
-clean_col <- keep_cols(mtx, f = is_zero, all = FALSE)
+clean_col <- keep_columns(mtx, f = is_zero, all = FALSE)
 expect_equal(clean_col, mtx)
-expect_message(keep_cols(mtx, f = is_zero, verbose = TRUE))
+expect_message(keep_columns(mtx, f = is_zero, verbose = TRUE))
 
 # Remove rows
 clean_row <- keep_rows(mtx, f = is_zero, all = TRUE)
 expect_equal(dim(clean_row), c(1, 3))
 expect_message(keep_rows(mtx, f = is_zero, all = TRUE, verbose = TRUE))
 
 # Remove columns
-clean_col <- keep_cols(mtx, f = is_zero, all = TRUE)
+clean_col <- keep_columns(mtx, f = is_zero, all = TRUE)
 expect_equal(dim(clean_col), c(5, 1))
-expect_message(keep_cols(mtx, f = is_zero, all = TRUE, verbose = TRUE))
+expect_message(keep_columns(mtx, f = is_zero, all = TRUE, verbose = TRUE))