generated documentation with ROxygen2

R-package/NAMESPACE

@@ -16,3 +16,6 @@ exportMethods(predict)
 import(methods)
 importClassesFrom(Matrix,dgCMatrix)
 importClassesFrom(Matrix,dgeMatrix)
+importFrom(data.table,":=")
+importFrom(data.table,data.table)
+importFrom(magrittr,"%>%")

R-package/man/agaricus.test.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgboost.R
 \docType{data}
 \name{agaricus.test}
 \alias{agaricus.test}

R-package/man/agaricus.train.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgboost.R
 \docType{data}
 \name{agaricus.train}
 \alias{agaricus.train}

R-package/man/getinfo.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/getinfo.xgb.DMatrix.R
 \docType{methods}
 \name{getinfo}
 \alias{getinfo}
@@ -12,9 +13,9 @@ getinfo(object, ...)
 \arguments{
 \item{object}{Object of class "xgb.DMatrix"}
 
-\item{name}{the name of the field to get}
-
 \item{...}{other parameters}
+
+\item{name}{the name of the field to get}
 }
 \description{
 Get information of an xgb.DMatrix object

R-package/man/predict-xgb.Booster-method.Rd

@@ -1,11 +1,12 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/predict.xgb.Booster.R
 \docType{methods}
 \name{predict,xgb.Booster-method}
 \alias{predict,xgb.Booster-method}
 \title{Predict method for eXtreme Gradient Boosting model}
 \usage{
-\S4method{predict}{xgb.Booster}(object, newdata, outputmargin = FALSE,
+\S4method{predict}{xgb.Booster}(object, newdata, missing = NULL,
-  ntreelimit = NULL)
+  outputmargin = FALSE, ntreelimit = NULL)
 }
 \arguments{
 \item{object}{Object of class "xgb.Boost"}

R-package/man/setinfo.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/setinfo.xgb.DMatrix.R
 \docType{methods}
 \name{setinfo}
 \alias{setinfo}
@@ -12,11 +13,11 @@ setinfo(object, ...)
 \arguments{
 \item{object}{Object of class "xgb.DMatrix"}
 
+\item{...}{other parameters}
+
 \item{name}{the name of the field to get}
 
 \item{info}{the specific field of information to set}
-
-\item{...}{other parameters}
 }
 \description{
 Set information of an xgb.DMatrix object

R-package/man/slice.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/slice.xgb.DMatrix.R
 \docType{methods}
 \name{slice}
 \alias{slice}
@@ -13,9 +14,9 @@ slice(object, ...)
 \arguments{
 \item{object}{Object of class "xgb.DMatrix"}
 
-\item{idxset}{a integer vector of indices of rows needed}
-
 \item{...}{other parameters}
+
+\item{idxset}{a integer vector of indices of rows needed}
 }
 \description{
 Get a new DMatrix containing the specified rows of

R-package/man/xgb.DMatrix.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.DMatrix.R
 \name{xgb.DMatrix}
 \alias{xgb.DMatrix}
 \title{Contruct xgb.DMatrix object}

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

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.DMatrix.save.R
 \name{xgb.DMatrix.save}
 \alias{xgb.DMatrix.save}
 \title{Save xgb.DMatrix object to binary file}

R-package/man/xgb.cv.Rd

@@ -1,10 +1,12 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.cv.R
 \name{xgb.cv}
 \alias{xgb.cv}
 \title{Cross Validation}
 \usage{
-xgb.cv(params = list(), data, nrounds, nfold, label = NULL, showsd = TRUE,
+xgb.cv(params = list(), data, nrounds, nfold, label = NULL,
-  metrics = list(), obj = NULL, feval = NULL, ...)
+  missing = NULL, showsd = TRUE, metrics = list(), obj = NULL,
+  feval = NULL, ...)
 }
 \arguments{
 \item{params}{the list of parameters. Commonly used ones are:

R-package/man/xgb.dump.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.dump.R
 \name{xgb.dump}
 \alias{xgb.dump}
 \title{Save xgboost model to text file}

R-package/man/xgb.importance.Rd

@@ -0,0 +1,33 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.importance.R
+\name{xgb.importance}
+\alias{xgb.importance}
+\title{Show importance of features in a model}
+\usage{
+xgb.importance(feature_names, filename_dump)
+}
+\arguments{
+\item{feature_names}{names of each feature as a character vector. Can be extracted from a sparse matrix.}
+
+\item{filename_dump}{the name of the text file.}
+}
+\description{
+Read a xgboost model in text file format. Return a data.table of the features with their weight.
+}
+\examples{
+data(agaricus.train, package='xgboost')
+data(agaricus.test, package='xgboost')
+
+#Both dataset are list with two items, a sparse matrix and labels (outcome column which will be learned).
+#Each column of the sparse Matrix is a feature in one hot encoding format.
+train <- agaricus.train
+test <- agaricus.test
+
+bst <- xgboost(data = train$data, label = train$label, max.depth = 2,
+               eta = 1, nround = 2,objective = "binary:logistic")
+xgb.dump(bst, 'xgb.model.dump')
+
+#agaricus.test$data@Dimnames[[2]] represents the column name of the sparse matrix.
+xgb.importance(agaricus.test$data@Dimnames[[2]], 'xgb.model.dump')
+}
+

R-package/man/xgb.load.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.load.R
 \name{xgb.load}
 \alias{xgb.load}
 \title{Load xgboost model from binary file}

R-package/man/xgb.save.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.save.R
 \name{xgb.save}
 \alias{xgb.save}
 \title{Save xgboost model to binary file}

R-package/man/xgb.train.Rd

@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgb.train.R
 \name{xgb.train}
 \alias{xgb.train}
 \title{eXtreme Gradient Boosting Training}

R-package/man/xgboost.Rd

@@ -1,10 +1,11 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/xgboost.R
 \name{xgboost}
 \alias{xgboost}
 \title{eXtreme Gradient Boosting (Tree) library}
 \usage{
-xgboost(data = NULL, label = NULL, params = list(), nrounds,
+xgboost(data = NULL, label = NULL, missing = NULL, params = list(),
-  verbose = 1, ...)
+  nrounds, verbose = 1, ...)
 }
 \arguments{
 \item{data}{takes \code{matrix}, \code{dgCMatrix}, local data file or