From 25f508e43e4c2393fbdda38196886bd766df7d2f Mon Sep 17 00:00:00 2001 From: hetong007 Date: Mon, 9 Feb 2015 17:48:52 -0800 Subject: [PATCH] update doc, resolve warnings --- R-package/R/predict.xgb.Booster.R | 1 - R-package/R/predict.xgb.Booster.handle.R | 9 +++++++-- R-package/R/xgb.save.raw.R | 10 +++++----- .../man/predict-xgb.Booster.handle-method.Rd | 18 ++++++++++++++++++ 4 files changed, 30 insertions(+), 8 deletions(-) create mode 100644 R-package/man/predict-xgb.Booster.handle-method.Rd diff --git a/R-package/R/predict.xgb.Booster.R b/R-package/R/predict.xgb.Booster.R index 52c40df9b..c5e1046eb 100644 --- a/R-package/R/predict.xgb.Booster.R +++ b/R-package/R/predict.xgb.Booster.R @@ -1,4 +1,3 @@ -setClass("xgb.Booster.handle") setClass("xgb.Booster", slots = c(handle = "xgb.Booster.handle", raw = "raw")) diff --git a/R-package/R/predict.xgb.Booster.handle.R b/R-package/R/predict.xgb.Booster.handle.R index a38aeb64e..3a09e02de 100644 --- a/R-package/R/predict.xgb.Booster.handle.R +++ b/R-package/R/predict.xgb.Booster.handle.R @@ -1,5 +1,12 @@ setClass("xgb.Booster.handle") +#' Predict method for eXtreme Gradient Boosting model handle +#' +#' Predicted values based on xgb.Booster.handle object. +#' +#' @param object Object of class "xgb.Boost.handle" +#' @param ... Parameters pass to \code{predict.xgb.Booster} +#' setMethod("predict", signature = "xgb.Booster.handle", definition = function(object, ...) { if (class(object) != "xgb.Booster.handle"){ @@ -7,8 +14,6 @@ setMethod("predict", signature = "xgb.Booster.handle", } bst <- xgb.handleToBooster(object) - # Avoid save a handle without update - # bst$raw <- xgb.save.raw(object) ret = predict(bst, ...) return(ret) diff --git a/R-package/R/xgb.save.raw.R b/R-package/R/xgb.save.raw.R index ee217aa85..7f3a2df21 100644 --- a/R-package/R/xgb.save.raw.R +++ b/R-package/R/xgb.save.raw.R @@ -17,12 +17,12 @@ #' pred <- predict(bst, test$data) #' @export #' -xgb.save.raw <- function(handle) { - if (class(handle) == "xgb.Booster"){ - handle <- handle$handle +xgb.save.raw <- function(model) { + if (class(model) == "xgb.Booster"){ + model <- model$handle } - if (class(handle) == "xgb.Booster.handle") { - raw <- .Call("XGBoosterModelToRaw_R", handle, PACKAGE = "xgboost") + if (class(model) == "xgb.Booster.handle") { + raw <- .Call("XGBoosterModelToRaw_R", model, PACKAGE = "xgboost") return(raw) } stop("xgb.raw: the input must be xgb.Booster.handle. Use xgb.DMatrix.save to save diff --git a/R-package/man/predict-xgb.Booster.handle-method.Rd b/R-package/man/predict-xgb.Booster.handle-method.Rd new file mode 100644 index 000000000..cc9ba29f9 --- /dev/null +++ b/R-package/man/predict-xgb.Booster.handle-method.Rd @@ -0,0 +1,18 @@ +% Generated by roxygen2 (4.1.0): do not edit by hand +% Please edit documentation in R/predict.xgb.Booster.handle.R +\docType{methods} +\name{predict,xgb.Booster.handle-method} +\alias{predict,xgb.Booster.handle-method} +\title{Predict method for eXtreme Gradient Boosting model handle} +\usage{ +\S4method{predict}{xgb.Booster.handle}(object, ...) +} +\arguments{ +\item{object}{Object of class "xgb.Boost.handle"} + +\item{...}{Parameters pass to \code{predict.xgb.Booster}} +} +\description{ +Predicted values based on xgb.Booster.handle object. +} +