From 9d1d76532da59be5d3ff2b612a7279143f6d94b0 Mon Sep 17 00:00:00 2001 From: pommedeterresautee Date: Mon, 16 Mar 2015 00:10:18 +0100 Subject: [PATCH] documentation --- R-package/R/nrow.xgb.DMatrix.R | 4 ++-- R-package/man/{nrow.Rd => nrow-xgb.DMatrix-method.Rd} | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) rename R-package/man/{nrow.Rd => nrow-xgb.DMatrix-method.Rd} (81%) diff --git a/R-package/R/nrow.xgb.DMatrix.R b/R-package/R/nrow.xgb.DMatrix.R index 16e4098c2..37d0fa811 100644 --- a/R-package/R/nrow.xgb.DMatrix.R +++ b/R-package/R/nrow.xgb.DMatrix.R @@ -1,8 +1,8 @@ setGeneric("nrow") #' @param x Object of class \code{xgb.DMatrix} -#' @title \code{nrow} return the number of rows present in x. -#' @rdname nrow +#' @title Number of xgb.DMatrix rows +#' @description \code{nrow} return the number of rows present in the \code{xgb.DMatrix}. #' @examples #' data(agaricus.train, package='xgboost') #' train <- agaricus.train diff --git a/R-package/man/nrow.Rd b/R-package/man/nrow-xgb.DMatrix-method.Rd similarity index 81% rename from R-package/man/nrow.Rd rename to R-package/man/nrow-xgb.DMatrix-method.Rd index 8187df3e0..953e620bf 100644 --- a/R-package/man/nrow.Rd +++ b/R-package/man/nrow-xgb.DMatrix-method.Rd @@ -3,7 +3,7 @@ \docType{methods} \name{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{ \S4method{nrow}{xgb.DMatrix}(x) } @@ -11,7 +11,7 @@ \item{x}{Object of class \code{xgb.DMatrix}} } \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{ data(agaricus.train, package='xgboost')