hide helper function

saezlab · Apr 3, 2020 · e541f60 · e541f60
1 parent 4b7fdb2
commit e541f60
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/R/helpers.R b/R/helpers.R
@@ -6,7 +6,9 @@
 #' @param df A regulon table from dorothea package.
 #'
 #' @return Regulons in the \code{viper} format.
-df2regulon <- function(df) {
+#'
+#' @keywords internal
+.df2regulon <- function(df) {
   regulon_list = split(df, df$tf)
 
   viper_regulons = lapply(regulon_list, function(regulon) {

diff --git a/R/viper_wrapper.R b/R/viper_wrapper.R
@@ -82,7 +82,7 @@ run_viper.Seurat <- function(input, regulons, options = list(), tidy = FALSE) {
 run_viper.matrix <- function(input, regulons, options = list(), tidy=FALSE) {
   viper_res <- do.call(viper::viper,
                       c(list(eset = input,
-                             regulon = df2regulon(regulons)),
+                             regulon = .df2regulon(regulons)),
                         options))
 
   if (tidy) {

diff --git a/man/df2regulon.Rd → man/dot-df2regulon.Rd b/man/df2regulon.Rd → man/dot-df2regulon.Rd
diff --git a/tests/testthat/test-helpers.R b/tests/testthat/test-helpers.R
@@ -1,6 +1,6 @@
 test_that("test df2regulon", {
 
-  res = df2regulon(dorothea_hs)
+  res = .df2regulon(dorothea_hs)
 
   # test if a list is returned
   expect_equal(class(res), "list")