diff --git a/R-package/R/xgb.train.R b/R-package/R/xgb.train.R index e3316527e..95be9b0d5 100644 --- a/R-package/R/xgb.train.R +++ b/R-package/R/xgb.train.R @@ -3,12 +3,16 @@ #' The training function of xgboost #' #' @param params the list of parameters. Commonly used ones are: -#' objective: objective function, common ones are -#' - reg:linear linear regression -#' - binary:logistic logistic regression for classification -#' eta: step size of each boosting step -#' max_depth: maximum depth of the tree -#' nthread: number of thread used in training, if not set, all threads are used +#' \itemize{ +#' \item \code{objective} objective function, common ones are +#' \itemize{ +#' \item \code{reg:linear} linear regression +#' \item \code{binary:logistic} logistic regression for classification +#' } +#' \item \code{eta} step size of each boosting step +#' \item \code{max_depth} maximum depth of the tree +#' \item \code{nthread} number of thread used in training, if not set, all threads are used +#' } #' #' See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for #' further details. See also demo/demo.R for walkthrough example in R. diff --git a/R-package/R/xgboost.R b/R-package/R/xgboost.R index 96649790c..c6fc99980 100644 --- a/R-package/R/xgboost.R +++ b/R-package/R/xgboost.R @@ -7,12 +7,16 @@ #' @param label the response variable. User should not set this field, # if data is local data file or \code{xgb.DMatrix}. #' @param params the list of parameters. Commonly used ones are: -#' objective: objective function, common ones are -#' - reg:linear linear regression -#' - binary:logistic logistic regression for classification -#' eta: step size of each boosting step -#' max_depth: maximum depth of the tree -#' nthread: number of thread used in training, if not set, all threads are used +#' \itemize{ +#' \item \code{objective} objective function, common ones are +#' \itemize{ +#' \item \code{reg:linear} linear regression +#' \item \code{binary:logistic} logistic regression for classification +#' } +#' \item \code{eta} step size of each boosting step +#' \item \code{max_depth} maximum depth of the tree +#' \item \code{nthread} number of thread used in training, if not set, all threads are used +#' } #' #' See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for #' further details. See also demo/demo.R for walkthrough example in R. diff --git a/R-package/man/xgb.train.Rd b/R-package/man/xgb.train.Rd index 428ac9205..8e0d6b498 100644 --- a/R-package/man/xgb.train.Rd +++ b/R-package/man/xgb.train.Rd @@ -8,12 +8,16 @@ xgb.train(params = list(), dtrain, nrounds, watchlist = list(), } \arguments{ \item{params}{the list of parameters. Commonly used ones are: - objective: objective function, common ones are - - reg:linear linear regression - - binary:logistic logistic regression for classification - eta: step size of each boosting step - max_depth: maximum depth of the tree - nthread: number of thread used in training, if not set, all threads are used +\itemize{ + \item \code{objective} objective function, common ones are + \itemize{ + \item \code{reg:linear} linear regression + \item \code{binary:logistic} logistic regression for classification + } + \item \code{eta} step size of each boosting step + \item \code{max_depth} maximum depth of the tree + \item \code{nthread} number of thread used in training, if not set, all threads are used +} See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for further details. See also demo/demo.R for walkthrough example in R.} diff --git a/R-package/man/xgboost.Rd b/R-package/man/xgboost.Rd index d9de7a421..a76ce5b3d 100644 --- a/R-package/man/xgboost.Rd +++ b/R-package/man/xgboost.Rd @@ -13,12 +13,16 @@ xgboost(data = NULL, label = NULL, params = list(), nrounds, \item{label}{the response variable. User should not set this field,} \item{params}{the list of parameters. Commonly used ones are: - objective: objective function, common ones are - - reg:linear linear regression - - binary:logistic logistic regression for classification - eta: step size of each boosting step - max_depth: maximum depth of the tree - nthread: number of thread used in training, if not set, all threads are used +\itemize{ + \item \code{objective} objective function, common ones are + \itemize{ + \item \code{reg:linear} linear regression + \item \code{binary:logistic} logistic regression for classification + } + \item \code{eta} step size of each boosting step + \item \code{max_depth} maximum depth of the tree + \item \code{nthread} number of thread used in training, if not set, all threads are used +} See \url{https://github.com/tqchen/xgboost/wiki/Parameters} for further details. See also demo/demo.R for walkthrough example in R.}