R/createPredictors.R

In gi0na/ghypernet: Fit and Simulate Generalised Hypergeometric Ensembles of Graphs

#' Create a nrmpredictor object from passed argument
#'
#' @param predictors the dataframe or list of predictors for to apply nrm model selection
#' @param ... additional parameters passed to the different methods (currently disabled)
#'
#' @return nested list of nrmpredictor class
#' @export
#'
#' @examples
#' data('highschool.predictors')
#' predictors <- create_predictors(highschool.predictors)
#' 
create_predictors <- function(predictors, 
    ...) {
    UseMethod("create_predictors")
}


#' Create a nrmpredictor object from list
#'
#' @param predictors the dataframe or list of predictors for to apply nrm model selection
#' @param ... additional parameters used to creating the predictor object (currently disabled)
#'
#' @return nested list of nrmpredictor class
#' @export
#'
#' @examples
#' data('highschool.predictors')
#' predictors <- create_predictors(highschool.predictors)
#'

create_predictors.list <- function(predictors, 
                                  ...) {
  message("Creating predictors list...")
  predictors <- lapply(X = predictors, 
                       FUN = list)
  for (i in 1:length(predictors)) names(predictors[[i]]) <- names(predictors)[i]
  class(predictors) <- "nrmpredictor"
  return(predictors)
}

# create_predictors.data.frame <-
# function(predictor, ...){
# ##TODO }

# create_predictors.matrix <-
# function(predictor, ...){
# ##TODO }