From 81caba5dce165c2df4ddc75059447c9296914041 Mon Sep 17 00:00:00 2001 From: pommedeterresautee Date: Sun, 15 Mar 2015 23:52:00 +0100 Subject: [PATCH] new nrow function for xgb.DMatrix --- R-package/NAMESPACE | 2 +- R-package/R/nrow.xgb.DMatrix.R | 18 ++++++++++++++++++ R-package/man/nrow.Rd | 22 ++++++++++++++++++++++ 3 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 R-package/R/nrow.xgb.DMatrix.R create mode 100644 R-package/man/nrow.Rd diff --git a/R-package/NAMESPACE b/R-package/NAMESPACE index ac74b8434..a1d296d80 100644 --- a/R-package/NAMESPACE +++ b/R-package/NAMESPACE @@ -16,6 +16,7 @@ export(xgb.save) export(xgb.save.raw) export(xgb.train) export(xgboost) +exportMethods(nrow) exportMethods(predict) import(methods) importClassesFrom(Matrix,dgCMatrix) @@ -52,4 +53,3 @@ importFrom(stringr,str_match) importFrom(stringr,str_replace) importFrom(stringr,str_split) importFrom(stringr,str_trim) -import(vcd) diff --git a/R-package/R/nrow.xgb.DMatrix.R b/R-package/R/nrow.xgb.DMatrix.R new file mode 100644 index 000000000..16e4098c2 --- /dev/null +++ b/R-package/R/nrow.xgb.DMatrix.R @@ -0,0 +1,18 @@ +setGeneric("nrow") + +#' @param x Object of class \code{xgb.DMatrix} +#' @title \code{nrow} return the number of rows present in x. +#' @rdname nrow +#' @examples +#' data(agaricus.train, package='xgboost') +#' train <- agaricus.train +#' dtrain <- xgb.DMatrix(train$data, label=train$label) +#' stopifnot(nrow(dtrain) == nrow(train$data)) +#' +#' @export +setMethod("nrow", + signature = "xgb.DMatrix", + definition = function(x) { + xgb.numrow(x) + } +) diff --git a/R-package/man/nrow.Rd b/R-package/man/nrow.Rd new file mode 100644 index 000000000..8187df3e0 --- /dev/null +++ b/R-package/man/nrow.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2 (4.1.0): do not edit by hand +% Please edit documentation in R/nrow.xgb.DMatrix.R +\docType{methods} +\name{nrow,xgb.DMatrix-method} +\alias{nrow,xgb.DMatrix-method} +\title{\code{nrow} return the number of rows present in x.} +\usage{ +\S4method{nrow}{xgb.DMatrix}(x) +} +\arguments{ +\item{x}{Object of class \code{xgb.DMatrix}} +} +\description{ +\code{nrow} return the number of rows present in x. +} +\examples{ +data(agaricus.train, package='xgboost') +train <- agaricus.train +dtrain <- xgb.DMatrix(train$data, label=train$label) +stopifnot(nrow(dtrain) == nrow(train$data)) +} +