From 76d5fc7e78550970beab7904fd1cc8874f4a33d8 Mon Sep 17 00:00:00 2001 From: hetong Date: Mon, 1 Sep 2014 17:43:28 -0700 Subject: [PATCH] attemp to fix line breaking issue of doc --- R-package/R/xgb.dump.R | 9 ++++++--- R-package/R/xgb.train.R | 9 +++++---- R-package/man/xgb.dump.Rd | 8 +++++--- R-package/man/xgb.train.Rd | 9 +++++---- 4 files changed, 21 insertions(+), 14 deletions(-) diff --git a/R-package/R/xgb.dump.R b/R-package/R/xgb.dump.R index dc3f431a2..09406dc99 100644 --- a/R-package/R/xgb.dump.R +++ b/R-package/R/xgb.dump.R @@ -4,9 +4,12 @@ #' #' @param model the model object. #' @param fname the name of the binary file. -#' @param fmap feature map file representing the type of feature, to make it -#' look nice, run inst/examples/demo.R for result and inst/examples/featmap.txt for example -#' Format: https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model +#' @param fmap feature map file representing the type of feature. +#' Detailed description could be found at +#' \url{https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model}. +#' Run inst/examples/demo.R for the result and inst/examples/featmap.txt +#' for example Format. +#' #' #' @examples #' data(iris) diff --git a/R-package/R/xgb.train.R b/R-package/R/xgb.train.R index 99a6dcc2d..58a575d03 100644 --- a/R-package/R/xgb.train.R +++ b/R-package/R/xgb.train.R @@ -24,10 +24,11 @@ #' watchlist=list(validation1=mat1, validation2=mat2) to watch #' the performance of each round's model on mat1 and mat2 #' -#' @param obj customized objective function. Given prediction and dtrain, -#' return gradient and second order gradient. -#' @param feval custimized evaluation function. Given prediction and dtrain, -#' return a \code{list(metric='metric-name', value='metric-value')}. +#' @param obj customized objective function. Returns gradient and second order +#' gradient with given prediction and dtrain, +#' @param feval custimized evaluation function. Returns +#' \code{list(metric='metric-name', value='metric-value')} with given +#' prediction and dtrain, #' @param ... other parameters to pass to \code{params}. #' #' @details diff --git a/R-package/man/xgb.dump.Rd b/R-package/man/xgb.dump.Rd index 69ec13300..4d6933811 100644 --- a/R-package/man/xgb.dump.Rd +++ b/R-package/man/xgb.dump.Rd @@ -10,9 +10,11 @@ xgb.dump(model, fname, fmap = "") \item{fname}{the name of the binary file.} -\item{fmap}{feature map file representing the type of feature, to make it - look nice, run inst/examples/demo.R for result and inst/examples/featmap.txt for example - Format: https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model} +\item{fmap}{feature map file representing the type of feature. + Detailed description could be found at + \url{https://github.com/tqchen/xgboost/wiki/Binary-Classification#dump-model}. + Run inst/examples/demo.R for the result and inst/examples/featmap.txt + for example Format.} } \description{ Save a xgboost model to text file. Could be parsed later. diff --git a/R-package/man/xgb.train.Rd b/R-package/man/xgb.train.Rd index aa2778501..4da3b0013 100644 --- a/R-package/man/xgb.train.Rd +++ b/R-package/man/xgb.train.Rd @@ -32,11 +32,12 @@ xgb.train(params = list(), dtrain, nrounds, watchlist = list(), watchlist=list(validation1=mat1, validation2=mat2) to watch the performance of each round's model on mat1 and mat2} -\item{obj}{customized objective function. Given prediction and dtrain, -return gradient and second order gradient.} +\item{obj}{customized objective function. Returns gradient and second order +gradient with given prediction and dtrain,} -\item{feval}{custimized evaluation function. Given prediction and dtrain, -return a \code{list(metric='metric-name', value='metric-value')}.} +\item{feval}{custimized evaluation function. Returns +\code{list(metric='metric-name', value='metric-value')} with given +prediction and dtrain,} \item{...}{other parameters to pass to \code{params}.} }