R/method_manipulation.R

In duohongrui/simmethods: A collection of 40+ simulation methods for singlce-cell RNA seqencing data

#' @importFrom dplyr %>%
NULL

#' Get Information of Methods
#'
#' @param method One or more method names. Default is all.
#'
#' @return A list.
#' @importFrom purrr map
#' @importFrom stringr str_split
#' @importFrom stats setNames
#' @importFrom utils lsf.str
#' @export
#'
#' @examples
#' # get_method <- get_method()
#' # get_method <- get_method(method = c("splat", "PROSSTT"))
get_method <-function(method = "all"){
  if(!requireNamespace("crayon", quietly = TRUE)){
    utils::install.packages("crayon")
  }
  env <- asNamespace("simmethods")
  func_name <- as.character(lsf.str(env, pattern = "_definition"))
  right_name <- stringr::str_split(func_name, pattern = "_", simplify = T)[,1]
  if(method[1] != "all"){
    purrr::map(method, function(z){
      # Make sure the method name is valid
      if(!z %in% right_name) stop(crayon::red(paste(z, "is not wrapped in simmethods package. Please check your spelling or use () to get the right name")))
    })
    func_name <- paste0(method, "_method_definition")
    set_name_method <- method
  }else{
    set_name_method <- right_name
  }
  # Get the information of methods
  methods_return <- purrr::map(func_name, .f = function(x){
    paste0(x,"()") %>% parse(text = .) %>% eval()
  }) %>% setNames(set_name_method)
  methods_return
}