improve document format

This commit is contained in:
hetong
2014-08-30 15:14:36 -07:00
parent 2c1aabf6b0
commit a06f01e8ec
6 changed files with 27 additions and 9 deletions

View File

@@ -1,14 +1,20 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
\docType{methods}
\name{getinfo}
\alias{getinfo}
\alias{getinfo,xgb.DMatrix-method}
\title{Get information of an xgb.DMatrix object}
\usage{
getinfo(object, ...)
\S4method{getinfo}{xgb.DMatrix}(object, name)
}
\arguments{
\item{object}{Object of class "xgb.DMatrix"}
\item{name}{the name of the field to get}
\item{...}{other parameters}
}
\description{
Get information of an xgb.DMatrix object

View File

@@ -1,15 +1,21 @@
% Generated by roxygen2 (4.0.1): do not edit by hand
\docType{methods}
\name{slice}
\alias{slice}
\alias{slice,xgb.DMatrix-method}
\title{Get a new DMatrix containing the specified rows of
orginal xgb.DMatrix object}
\usage{
slice(object, ...)
\S4method{slice}{xgb.DMatrix}(object, idxset, ...)
}
\arguments{
\item{object}{Object of class "xgb.DMatrix"}
\item{idxset}{a integer vector of indices of rows needed}
\item{...}{other parameters}
}
\description{
Get a new DMatrix containing the specified rows of

View File

@@ -6,7 +6,7 @@
xgb.DMatrix.save(DMatrix, fname)
}
\arguments{
\item{model}{the model object.}
\item{DMatrix}{the model object.}
\item{fname}{the name of the binary file.}
}