documentation

This commit is contained in:
pommedeterresautee 2015-03-16 00:10:18 +01:00
parent 6ca76fe784
commit 9d1d76532d
2 changed files with 4 additions and 4 deletions

View File

@ -1,8 +1,8 @@
setGeneric("nrow") setGeneric("nrow")
#' @param x Object of class \code{xgb.DMatrix} #' @param x Object of class \code{xgb.DMatrix}
#' @title \code{nrow} return the number of rows present in x. #' @title Number of xgb.DMatrix rows
#' @rdname nrow #' @description \code{nrow} return the number of rows present in the \code{xgb.DMatrix}.
#' @examples #' @examples
#' data(agaricus.train, package='xgboost') #' data(agaricus.train, package='xgboost')
#' train <- agaricus.train #' train <- agaricus.train

View File

@ -3,7 +3,7 @@
\docType{methods} \docType{methods}
\name{nrow,xgb.DMatrix-method} \name{nrow,xgb.DMatrix-method}
\alias{nrow,xgb.DMatrix-method} \alias{nrow,xgb.DMatrix-method}
\title{\code{nrow} return the number of rows present in x.} \title{Number of xgb.DMatrix rows}
\usage{ \usage{
\S4method{nrow}{xgb.DMatrix}(x) \S4method{nrow}{xgb.DMatrix}(x)
} }
@ -11,7 +11,7 @@
\item{x}{Object of class \code{xgb.DMatrix}} \item{x}{Object of class \code{xgb.DMatrix}}
} }
\description{ \description{
\code{nrow} return the number of rows present in x. \code{nrow} return the number of rows present in the \code{xgb.DMatrix}.
} }
\examples{ \examples{
data(agaricus.train, package='xgboost') data(agaricus.train, package='xgboost')