add note on factor levels for classification

imbs-hl · Dec 1, 2015 · 9c93cf8 · 9c93cf8
1 parent 9e3d770
commit 9c93cf8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/ranger-r-package/ranger/R/predict.R b/ranger-r-package/ranger/R/predict.R
@@ -225,6 +225,9 @@ predict.ranger.forest <- function(object, data, predict.all = FALSE,
 }
 
 ##' Prediction with new data and a saved forest from Ranger.
+##' 
+##' For classification and predict.all = TRUE, a matrix of factor levels is returned. 
+##' To retrieve the corresponding factor levels, use rf$forest$levels, if rf is the ranger object.
 ##'
 ##' @title Ranger prediction
 ##' @param object Ranger \code{ranger} object.

diff --git a/ranger-r-package/ranger/man/predict.ranger.Rd b/ranger-r-package/ranger/man/predict.ranger.Rd
@@ -38,6 +38,10 @@ Object of class \code{ranger.prediction} with elements
 \description{
 Prediction with new data and a saved forest from Ranger.
 }
+\details{
+For classification and predict.all = TRUE, a matrix of factor levels is returned.
+To retrieve the corresponding factor levels, use rf$forest$levels, if rf is the ranger object.
+}
 \author{
 Marvin N. Wright
 }