[R] R raw serialization. (#5123)

* Add bindings for serialization.
* Change `xgb.save.raw' into full serialization instead of simple model.
* Add `xgb.load.raw' for unserialization.
* Run devtools.

R-package/man/agaricus.test.Rd

@@ -4,8 +4,10 @@
 \name{agaricus.test}
 \alias{agaricus.test}
 \title{Test part from Mushroom Data Set}
-\format{A list containing a label vector, and a dgCMatrix object with 1611
-rows and 126 variables}
+\format{
+A list containing a label vector, and a dgCMatrix object with 1611
+rows and 126 variables
+}
 \usage{
 data(agaricus.test)
 }

R-package/man/agaricus.train.Rd

@@ -4,8 +4,10 @@
 \name{agaricus.train}
 \alias{agaricus.train}
 \title{Training part from Mushroom Data Set}
-\format{A list containing a label vector, and a dgCMatrix object with 6513
-rows and 127 variables}
+\format{
+A list containing a label vector, and a dgCMatrix object with 6513
+rows and 127 variables
+}
 \usage{
 data(agaricus.train)
 }

R-package/man/xgb.attr.Rd

@@ -55,7 +55,7 @@ than for \code{xgb.Booster}, since only just a handle (pointer) would need to be
 That would only matter if attributes need to be set many times.
 Note, however, that when feeding a handle of an \code{xgb.Booster} object to the attribute setters,
 the raw model cache of an \code{xgb.Booster} object would not be automatically updated,
-and it would be user's responsibility to call \code{xgb.save.raw} to update it.
+and it would be user's responsibility to call \code{xgb.serialize} to update it.
 
 The \code{xgb.attributes<-} setter either updates the existing or adds one or several attributes,
 but it doesn't delete the other existing attributes.

R-package/man/xgb.cv.Rd

@@ -135,7 +135,7 @@ An object of class \code{xgb.cv.synchronous} with the following elements:
         (only available with early stopping).
   \item \code{pred} CV prediction values available when \code{prediction} is set.
         It is either vector or matrix (see \code{\link{cb.cv.predict}}).
-  \item \code{models} a liost of the CV folds' models. It is only available with the explicit
+  \item \code{models} a list of the CV folds' models. It is only available with the explicit
         setting of the \code{cb.cv.predict(save_models = TRUE)} callback.
 }
 }

R-package/man/xgb.load.raw.Rd

@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/xgb.load.raw.R
+\name{xgb.load.raw}
+\alias{xgb.load.raw}
+\title{Load serialised xgboost model from R's raw vector}
+\usage{
+xgb.load.raw(buffer)
+}
+\arguments{
+\item{buffer}{the buffer returned by xgb.save.raw}
+}
+\description{
+User can generate raw memory buffer by calling xgb.save.raw
+}

R-package/man/xgb.save.raw.Rd

@@ -3,7 +3,7 @@
 \name{xgb.save.raw}
 \alias{xgb.save.raw}
 \title{Save xgboost model to R's raw vector,
-user can call xgb.load to load the model back from raw vector}
+user can call xgb.load.raw to load the model back from raw vector}
 \usage{
 xgb.save.raw(model)
 }
@@ -18,10 +18,10 @@ data(agaricus.train, package='xgboost')
 data(agaricus.test, package='xgboost')
 train <- agaricus.train
 test <- agaricus.test
-bst <- xgboost(data = train$data, label = train$label, max_depth = 2, 
+bst <- xgboost(data = train$data, label = train$label, max_depth = 2,
                eta = 1, nthread = 2, nrounds = 2,objective = "binary:logistic")
 raw <- xgb.save.raw(bst)
-bst <- xgb.load(raw)
+bst <- xgb.load.raw(raw)
 pred <- predict(bst, test$data)
 
 }

R-package/man/xgb.serialize.Rd

@@ -0,0 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/xgb.serialize.R
+\name{xgb.serialize}
+\alias{xgb.serialize}
+\title{Serialize the booster instance into R's raw vector.  The serialization method differs
+from \code{\link{xgb.save.raw}} as the latter one saves only the model but not
+parameters.  This serialization format is not stable across different xgboost versions.}
+\usage{
+xgb.serialize(booster)
+}
+\arguments{
+\item{booster}{the booster instance}
+}
+\description{
+Serialize the booster instance into R's raw vector.  The serialization method differs
+from \code{\link{xgb.save.raw}} as the latter one saves only the model but not
+parameters.  This serialization format is not stable across different xgboost versions.
+}
+\examples{
+data(agaricus.train, package='xgboost')
+data(agaricus.test, package='xgboost')
+train <- agaricus.train
+test <- agaricus.test
+bst <- xgboost(data = train$data, label = train$label, max_depth = 2,
+               eta = 1, nthread = 2, nrounds = 2,objective = "binary:logistic")
+raw <- xgb.serialize(bst)
+bst <- xgb.unserialize(raw)
+
+}

R-package/man/xgb.unserialize.Rd

@@ -0,0 +1,14 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/xgb.unserialize.R
+\name{xgb.unserialize}
+\alias{xgb.unserialize}
+\title{Load the instance back from \code{\link{xgb.serialize}}}
+\usage{
+xgb.unserialize(buffer)
+}
+\arguments{
+\item{buffer}{the buffer containing booster instance saved by \code{\link{xgb.serialize}}}
+}
+\description{
+Load the instance back from \code{\link{xgb.serialize}}
+}