Wording improvement

R-package/R/xgb.importance.R

@@ -21,7 +21,7 @@
 #' @details 
 #' This is the function to understand the model trained (and through your model, your data).
 #' 
-#' Results are returned for both linear and tree models.
+#' This function is for both linear and tree models.
 #' 
 #' \code{data.table} is returned by the function. 
 #' The columns are :
@@ -32,8 +32,9 @@
 #'   \item \code{Weight} percentage representing the relative number of times a feature have been taken into trees.
 #' }
 #' 
-#' If you don't provide name, index of the features are used.
-#' They are extracted from the boost dump (made on the C++ side), the index starts at 0 (usual in C++) instead of 1 (usual in R).
+#' If you don't provide \code{feature_names}, index of the features will be used instead.
+#' 
+#' Because the index is extracted from the model dump (made on the C++ side), it starts at 0 (usual in C++) instead of 1 (usual in R).
 #' 
 #' Co-occurence count
 #' ------------------
@@ -47,10 +48,6 @@
 #' @examples
 #' data(agaricus.train, package='xgboost')
 #' 
-#' # Both dataset are list with two items, a sparse matrix and labels 
-#' # (labels = outcome column which will be learned). 
-#' # Each column of the sparse Matrix is a feature in one hot encoding format.
-#' 
 #' bst <- xgboost(data = agaricus.train$data, label = agaricus.train$label, max.depth = 2, 
 #'                eta = 1, nthread = 2, nround = 2,objective = "binary:logistic")
 #' 
@@ -114,8 +111,6 @@ xgb.importance <- function(feature_names = NULL, model = NULL, data = NULL, labe
   result
 }
 
-
-
 # Avoid error messages during CRAN check.
 # The reason is that these variables are never declared
 # They are mainly column names inferred by Data.table...