[R] parameter style consistency

R-package/R/xgb.plot.multi.trees.R

@@ -2,19 +2,12 @@
 #' 
 #' Visualization of the ensemble of trees as a single collective unit.
 #'
-#' @importFrom data.table data.table
-#' @importFrom data.table rbindlist
-#' @importFrom data.table setnames
-#' @importFrom data.table :=
-#' @importFrom magrittr %>%
-#' @importFrom stringr str_detect
-#' @importFrom stringr str_extract
-#' 
 #' @param model dump generated by the \code{xgb.train} function.
 #' @param feature_names names of each feature as a \code{character} vector. Can be extracted from a sparse matrix (see example). If model dump already contains feature names, this argument should be \code{NULL}.
-#' @param features.keep number of features to keep in each position of the multi trees.
-#' @param plot.width width in pixels of the graph to produce
-#' @param plot.height height in pixels of the graph to produce
+#' @param features_keep number of features to keep in each position of the multi trees.
+#' @param plot_width width in pixels of the graph to produce
+#' @param plot_height height in pixels of the graph to produce
+#' @param ... currently not used
 #' 
 #' @return Two graphs showing the distribution of the model deepness.
 #' 
@@ -34,7 +27,7 @@
 #' Moreover, the trees tend to reuse the same features.
 #' 
 #' The function will project each tree on one, and keep for each position the 
-#' \code{features.keep} first features (based on Gain per feature measure).
+#' \code{features_keep} first features (based on Gain per feature measure).
 #' 
 #' This function is inspired by this blog post:
 #' \url{https://wellecks.wordpress.com/2015/02/21/peering-into-the-black-box-visualizing-lambdamart/}
@@ -42,15 +35,16 @@
 #' @examples
 #' data(agaricus.train, package='xgboost')
 #'
-#' bst <- xgboost(data = agaricus.train$data, label = agaricus.train$label, max.depth = 15,
-#'                  eta = 1, nthread = 2, nround = 30, objective = "binary:logistic",
+#' bst <- xgboost(data = agaricus.train$data, label = agaricus.train$label, max_depth = 15,
+#'                  eta = 1, nthread = 2, nrounds = 30, objective = "binary:logistic",
 #'                  min_child_weight = 50)
 #'
-#' p <- xgb.plot.multi.trees(model = bst, feature_names = agaricus.train$data@Dimnames[[2]], features.keep = 3)
+#' p <- xgb.plot.multi.trees(model = bst, feature_names = colnames(agaricus.train$data), features_keep = 3)
 #' print(p)
 #'
 #' @export
-xgb.plot.multi.trees <- function(model, feature_names = NULL, features.keep = 5, plot.width = NULL, plot.height = NULL){
+xgb.plot.multi.trees <- function(model, feature_names = NULL, features_keep = 5, plot_width = NULL, plot_height = NULL, ...){
+  check.deprecation(...)
   tree.matrix <- xgb.model.dt.tree(feature_names = feature_names, model = model)
   
   # first number of the path represents the tree, then the following numbers are related to the path to follow
@@ -80,7 +74,7 @@ xgb.plot.multi.trees <- function(model, feature_names = NULL, features.keep = 5,
   
   tree.matrix[,`:=`(abs.node.position=remove.tree(abs.node.position), Yes=remove.tree(Yes), No=remove.tree(No))]
   
-  nodes.dt <- tree.matrix[,.(Quality = sum(Quality)),by = .(abs.node.position, Feature)][,.(Text =paste0(Feature[1:min(length(Feature), features.keep)], " (", Quality[1:min(length(Quality), features.keep)], ")") %>% paste0(collapse = "\n")), by=abs.node.position]
+  nodes.dt <- tree.matrix[,.(Quality = sum(Quality)),by = .(abs.node.position, Feature)][,.(Text =paste0(Feature[1:min(length(Feature), features_keep)], " (", Quality[1:min(length(Quality), features_keep)], ")") %>% paste0(collapse = "\n")), by=abs.node.position]
   edges.dt <- tree.matrix[Feature != "Leaf",.(abs.node.position, Yes)] %>% list(tree.matrix[Feature != "Leaf",.(abs.node.position, No)]) %>% rbindlist() %>% setnames(c("From", "To")) %>% .[,.N,.(From, To)] %>% .[,N:=NULL]
   
   nodes <- DiagrammeR::create_nodes(nodes = nodes.dt[,abs.node.position],
@@ -104,11 +98,11 @@ xgb.plot.multi.trees <- function(model, feature_names = NULL, features.keep = 5,
                                     edges_df = edges,
                                     graph_attrs = "rankdir = LR")
   
-  DiagrammeR::render_graph(graph, width = plot.width, height = plot.height)  
+  DiagrammeR::render_graph(graph, width = plot_width, height = plot_height)  
 }
 
 globalVariables(
   c(
     "Feature", "no.nodes.abs.pos", "ID", "Yes", "No", "Tree", "yes.nodes.abs.pos", "abs.node.position"
   )
-)
+)