Skip to content

GitLab

Commit 029bcc42 authored by James Lamb's avatar James Lamb Committed by Laurae
Browse files

[R-package] updated examples and removed dontrun guards on them in roxygen (#1626)

parent abd73765
Show whitespace changes
Inline Side-by-side
Showing with 229 additions and 287 deletions
R-package/R/lgb.Booster.R
View file @ 029bcc42
...@@ -633,7 +633,6 @@ Booster <- R6::R6Class( ...@@ -633,7 +633,6 @@ Booster <- R6::R6Class(
#' number of columns corresponding to the number of trees. #' number of columns corresponding to the number of trees.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -651,7 +650,6 @@ Booster <- R6::R6Class( ...@@ -651,7 +650,6 @@ Booster <- R6::R6Class(
#' learning_rate = 1, #' learning_rate = 1,
#' early_stopping_rounds = 10) #' early_stopping_rounds = 10)
#' preds <- predict(model, test$data) #' preds <- predict(model, test$data)
#' }
#' #'
#' @rdname predict.lgb.Booster #' @rdname predict.lgb.Booster
#' @export #' @export
...@@ -692,7 +690,6 @@ predict.lgb.Booster <- function(object, ...@@ -692,7 +690,6 @@ predict.lgb.Booster <- function(object,
#' @return lgb.Booster #' @return lgb.Booster
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -713,7 +710,6 @@ predict.lgb.Booster <- function(object, ...@@ -713,7 +710,6 @@ predict.lgb.Booster <- function(object,
#' load_booster <- lgb.load(filename = "model.txt") #' load_booster <- lgb.load(filename = "model.txt")
#' model_string <- model$save_model_to_string(NULL) # saves best iteration #' model_string <- model$save_model_to_string(NULL) # saves best iteration
#' load_booster_from_str <- lgb.load(model_str = model_string) #' load_booster_from_str <- lgb.load(model_str = model_string)
#' }
#' #'
#' @rdname lgb.load #' @rdname lgb.load
#' @export #' @export
...@@ -752,7 +748,6 @@ lgb.load <- function(filename = NULL, model_str = NULL){ ...@@ -752,7 +748,6 @@ lgb.load <- function(filename = NULL, model_str = NULL){
#' @return lgb.Booster #' @return lgb.Booster
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -770,7 +765,6 @@ lgb.load <- function(filename = NULL, model_str = NULL){ ...@@ -770,7 +765,6 @@ lgb.load <- function(filename = NULL, model_str = NULL){
#' learning_rate = 1, #' learning_rate = 1,
#' early_stopping_rounds = 10) #' early_stopping_rounds = 10)
#' lgb.save(model, "model.txt") #' lgb.save(model, "model.txt")
#' }
#' #'
#' @rdname lgb.save #' @rdname lgb.save
#' @export #' @export
...@@ -801,7 +795,6 @@ lgb.save <- function(booster, filename, num_iteration = NULL){ ...@@ -801,7 +795,6 @@ lgb.save <- function(booster, filename, num_iteration = NULL){
#' @return json format of model #' @return json format of model
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -819,7 +812,6 @@ lgb.save <- function(booster, filename, num_iteration = NULL){ ...@@ -819,7 +812,6 @@ lgb.save <- function(booster, filename, num_iteration = NULL){
#' learning_rate = 1, #' learning_rate = 1,
#' early_stopping_rounds = 10) #' early_stopping_rounds = 10)
#' json_model <- lgb.dump(model) #' json_model <- lgb.dump(model)
#' }
#' #'
#' @rdname lgb.dump #' @rdname lgb.dump
#' @export #' @export
...@@ -847,7 +839,6 @@ lgb.dump <- function(booster, num_iteration = NULL){ ...@@ -847,7 +839,6 @@ lgb.dump <- function(booster, num_iteration = NULL){
#' @return vector of evaluation result #' @return vector of evaluation result
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -865,7 +856,6 @@ lgb.dump <- function(booster, num_iteration = NULL){ ...@@ -865,7 +856,6 @@ lgb.dump <- function(booster, num_iteration = NULL){
#' learning_rate = 1, #' learning_rate = 1,
#' early_stopping_rounds = 10) #' early_stopping_rounds = 10)
#' lgb.get.eval.result(model, "test", "l2") #' lgb.get.eval.result(model, "test", "l2")
#' }
#' #'
#' @rdname lgb.get.eval.result #' @rdname lgb.get.eval.result
#' @export #' @export
......
R-package/R/lgb.Dataset.R
View file @ 029bcc42
...@@ -311,6 +311,7 @@ Dataset <- R6::R6Class( ...@@ -311,6 +311,7 @@ Dataset <- R6::R6Class(
} else if (is.matrix(private$raw_data) || methods::is(private$raw_data, "dgCMatrix")) { } else if (is.matrix(private$raw_data) || methods::is(private$raw_data, "dgCMatrix")) {
# Check if dgCMatrix (sparse matrix column compressed) # Check if dgCMatrix (sparse matrix column compressed)
# NOTE: requires Matrix package
dim(private$raw_data) dim(private$raw_data)
} else { } else {
...@@ -392,9 +393,11 @@ Dataset <- R6::R6Class( ...@@ -392,9 +393,11 @@ Dataset <- R6::R6Class(
# Check for info name and handle # Check for info name and handle
if (is.null(private$info[[name]])) { if (is.null(private$info[[name]])) {
if (lgb.is.null.handle(private$handle)){ if (lgb.is.null.handle(private$handle)){
stop("Cannot perform getinfo before construct Dataset.") stop("Cannot perform getinfo before constructing Dataset.")
} }
# Get field size of info # Get field size of info
info_len <- 0L info_len <- 0L
info_len <- lgb.call("LGBM_DatasetGetFieldSize_R", info_len <- lgb.call("LGBM_DatasetGetFieldSize_R",
...@@ -646,7 +649,6 @@ Dataset <- R6::R6Class( ...@@ -646,7 +649,6 @@ Dataset <- R6::R6Class(
#' @return constructed dataset #' @return constructed dataset
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -654,7 +656,6 @@ Dataset <- R6::R6Class( ...@@ -654,7 +656,6 @@ Dataset <- R6::R6Class(
#' lgb.Dataset.save(dtrain, "lgb.Dataset.data") #' lgb.Dataset.save(dtrain, "lgb.Dataset.data")
#' dtrain <- lgb.Dataset("lgb.Dataset.data") #' dtrain <- lgb.Dataset("lgb.Dataset.data")
#' lgb.Dataset.construct(dtrain) #' lgb.Dataset.construct(dtrain)
#' }
#' #'
#' @export #' @export
lgb.Dataset <- function(data, lgb.Dataset <- function(data,
...@@ -692,7 +693,6 @@ lgb.Dataset <- function(data, ...@@ -692,7 +693,6 @@ lgb.Dataset <- function(data,
#' @return constructed dataset #' @return constructed dataset
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -700,7 +700,6 @@ lgb.Dataset <- function(data, ...@@ -700,7 +700,6 @@ lgb.Dataset <- function(data,
#' data(agaricus.test, package = "lightgbm") #' data(agaricus.test, package = "lightgbm")
#' test <- agaricus.test #' test <- agaricus.test
#' dtest <- lgb.Dataset.create.valid(dtrain, test$data, label = test$label) #' dtest <- lgb.Dataset.create.valid(dtrain, test$data, label = test$label)
#' }
#' #'
#' @export #' @export
lgb.Dataset.create.valid <- function(dataset, data, info = list(), ...) { lgb.Dataset.create.valid <- function(dataset, data, info = list(), ...) {
...@@ -720,13 +719,11 @@ lgb.Dataset.create.valid <- function(dataset, data, info = list(), ...) { ...@@ -720,13 +719,11 @@ lgb.Dataset.create.valid <- function(dataset, data, info = list(), ...) {
#' @param dataset Object of class \code{lgb.Dataset} #' @param dataset Object of class \code{lgb.Dataset}
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
#' dtrain <- lgb.Dataset(train$data, label = train$label) #' dtrain <- lgb.Dataset(train$data, label = train$label)
#' lgb.Dataset.construct(dtrain) #' lgb.Dataset.construct(dtrain)
#' }
#' #'
#' @export #' @export
lgb.Dataset.construct <- function(dataset) { lgb.Dataset.construct <- function(dataset) {
...@@ -754,7 +751,6 @@ lgb.Dataset.construct <- function(dataset) { ...@@ -754,7 +751,6 @@ lgb.Dataset.construct <- function(dataset) {
#' be directly used with an \code{lgb.Dataset} object. #' be directly used with an \code{lgb.Dataset} object.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -763,7 +759,6 @@ lgb.Dataset.construct <- function(dataset) { ...@@ -763,7 +759,6 @@ lgb.Dataset.construct <- function(dataset) {
#' stopifnot(nrow(dtrain) == nrow(train$data)) #' stopifnot(nrow(dtrain) == nrow(train$data))
#' stopifnot(ncol(dtrain) == ncol(train$data)) #' stopifnot(ncol(dtrain) == ncol(train$data))
#' stopifnot(all(dim(dtrain) == dim(train$data))) #' stopifnot(all(dim(dtrain) == dim(train$data)))
#' }
#' #'
#' @rdname dim #' @rdname dim
#' @export #' @export
...@@ -793,7 +788,6 @@ dim.lgb.Dataset <- function(x, ...) { ...@@ -793,7 +788,6 @@ dim.lgb.Dataset <- function(x, ...) {
#' Since row names are irrelevant, it is recommended to use \code{colnames} directly. #' Since row names are irrelevant, it is recommended to use \code{colnames} directly.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -803,7 +797,6 @@ dim.lgb.Dataset <- function(x, ...) { ...@@ -803,7 +797,6 @@ dim.lgb.Dataset <- function(x, ...) {
#' colnames(dtrain) #' colnames(dtrain)
#' colnames(dtrain) <- make.names(1:ncol(train$data)) #' colnames(dtrain) <- make.names(1:ncol(train$data))
#' print(dtrain, verbose = TRUE) #' print(dtrain, verbose = TRUE)
#' }
#' #'
#' @rdname dimnames.lgb.Dataset #' @rdname dimnames.lgb.Dataset
#' @export #' @export
...@@ -864,15 +857,14 @@ dimnames.lgb.Dataset <- function(x) { ...@@ -864,15 +857,14 @@ dimnames.lgb.Dataset <- function(x) {
#' @return constructed sub dataset #' @return constructed sub dataset
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
#' dtrain <- lgb.Dataset(train$data, label = train$label) #' dtrain <- lgb.Dataset(train$data, label = train$label)
#' #'
#' dsub <- lightgbm::slice(dtrain, 1:42) #' dsub <- lightgbm::slice(dtrain, 1:42)
#' lgb.Dataset.construct(dsub)
#' labels <- lightgbm::getinfo(dsub, "label") #' labels <- lightgbm::getinfo(dsub, "label")
#' }
#' #'
#' @export #' @export
slice <- function(dataset, ...) { slice <- function(dataset, ...) {
...@@ -911,7 +903,6 @@ slice.lgb.Dataset <- function(dataset, idxset, ...) { ...@@ -911,7 +903,6 @@ slice.lgb.Dataset <- function(dataset, idxset, ...) {
#' } #' }
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -923,7 +914,6 @@ slice.lgb.Dataset <- function(dataset, idxset, ...) { ...@@ -923,7 +914,6 @@ slice.lgb.Dataset <- function(dataset, idxset, ...) {
#' #'
#' labels2 <- lightgbm::getinfo(dtrain, "label") #' labels2 <- lightgbm::getinfo(dtrain, "label")
#' stopifnot(all(labels2 == 1 - labels)) #' stopifnot(all(labels2 == 1 - labels))
#' }
#' #'
#' @export #' @export
getinfo <- function(dataset, ...) { getinfo <- function(dataset, ...) {
...@@ -963,7 +953,6 @@ getinfo.lgb.Dataset <- function(dataset, name, ...) { ...@@ -963,7 +953,6 @@ getinfo.lgb.Dataset <- function(dataset, name, ...) {
#' } #' }
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -975,7 +964,6 @@ getinfo.lgb.Dataset <- function(dataset, name, ...) { ...@@ -975,7 +964,6 @@ getinfo.lgb.Dataset <- function(dataset, name, ...) {
#' #'
#' labels2 <- lightgbm::getinfo(dtrain, "label") #' labels2 <- lightgbm::getinfo(dtrain, "label")
#' stopifnot(all.equal(labels2, 1 - labels)) #' stopifnot(all.equal(labels2, 1 - labels))
#' }
#' #'
#' @export #' @export
setinfo <- function(dataset, ...) { setinfo <- function(dataset, ...) {
...@@ -1003,7 +991,6 @@ setinfo.lgb.Dataset <- function(dataset, name, info, ...) { ...@@ -1003,7 +991,6 @@ setinfo.lgb.Dataset <- function(dataset, name, info, ...) {
#' @return passed dataset #' @return passed dataset
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -1011,7 +998,6 @@ setinfo.lgb.Dataset <- function(dataset, name, info, ...) { ...@@ -1011,7 +998,6 @@ setinfo.lgb.Dataset <- function(dataset, name, info, ...) {
#' lgb.Dataset.save(dtrain, "lgb.Dataset.data") #' lgb.Dataset.save(dtrain, "lgb.Dataset.data")
#' dtrain <- lgb.Dataset("lgb.Dataset.data") #' dtrain <- lgb.Dataset("lgb.Dataset.data")
#' lgb.Dataset.set.categorical(dtrain, 1:2) #' lgb.Dataset.set.categorical(dtrain, 1:2)
#' }
#' #'
#' @rdname lgb.Dataset.set.categorical #' @rdname lgb.Dataset.set.categorical
#' @export #' @export
...@@ -1037,7 +1023,6 @@ lgb.Dataset.set.categorical <- function(dataset, categorical_feature) { ...@@ -1037,7 +1023,6 @@ lgb.Dataset.set.categorical <- function(dataset, categorical_feature) {
#' @return passed dataset #' @return passed dataset
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package ="lightgbm") #' data(agaricus.train, package ="lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -1046,7 +1031,6 @@ lgb.Dataset.set.categorical <- function(dataset, categorical_feature) { ...@@ -1046,7 +1031,6 @@ lgb.Dataset.set.categorical <- function(dataset, categorical_feature) {
#' test <- agaricus.test #' test <- agaricus.test
#' dtest <- lgb.Dataset(test$data, test = train$label) #' dtest <- lgb.Dataset(test$data, test = train$label)
#' lgb.Dataset.set.reference(dtest, dtrain) #' lgb.Dataset.set.reference(dtest, dtrain)
#' }
#' #'
#' @rdname lgb.Dataset.set.reference #' @rdname lgb.Dataset.set.reference
#' @export #' @export
...@@ -1070,13 +1054,11 @@ lgb.Dataset.set.reference <- function(dataset, reference) { ...@@ -1070,13 +1054,11 @@ lgb.Dataset.set.reference <- function(dataset, reference) {
#' #'
#' @examples #' @examples
#' #'
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
#' dtrain <- lgb.Dataset(train$data, label = train$label) #' dtrain <- lgb.Dataset(train$data, label = train$label)
#' lgb.Dataset.save(dtrain, "data.bin") #' lgb.Dataset.save(dtrain, "data.bin")
#' }
#' #'
#' @rdname lgb.Dataset.save #' @rdname lgb.Dataset.save
#' @export #' @export
......
R-package/R/lgb.cv.R
View file @ 029bcc42
...@@ -55,7 +55,6 @@ CVBooster <- R6::R6Class( ...@@ -55,7 +55,6 @@ CVBooster <- R6::R6Class(
#' @return a trained model \code{lgb.CVBooster}. #' @return a trained model \code{lgb.CVBooster}.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -68,7 +67,6 @@ CVBooster <- R6::R6Class( ...@@ -68,7 +67,6 @@ CVBooster <- R6::R6Class(
#' min_data = 1, #' min_data = 1,
#' learning_rate = 1, #' learning_rate = 1,
#' early_stopping_rounds = 10) #' early_stopping_rounds = 10)
#' }
#' @export #' @export
lgb.cv <- function(params = list(), lgb.cv <- function(params = list(),
data, data,
......
R-package/R/lgb.importance.R
View file @ 029bcc42
...@@ -16,13 +16,12 @@ ...@@ -16,13 +16,12 @@
#' } #' }
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
#' dtrain <- lgb.Dataset(train$data, label = train$label) #' dtrain <- lgb.Dataset(train$data, label = train$label)
#' #'
#' params = list(objective = "binary", #' params <- list(objective = "binary",
#' learning_rate = 0.01, num_leaves = 63, max_depth = -1, #' learning_rate = 0.01, num_leaves = 63, max_depth = -1,
#' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1) #' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1)
#' model <- lgb.train(params, dtrain, 20) #' model <- lgb.train(params, dtrain, 20)
...@@ -30,7 +29,6 @@ ...@@ -30,7 +29,6 @@
#' #'
#' tree_imp1 <- lgb.importance(model, percentage = TRUE) #' tree_imp1 <- lgb.importance(model, percentage = TRUE)
#' tree_imp2 <- lgb.importance(model, percentage = FALSE) #' tree_imp2 <- lgb.importance(model, percentage = FALSE)
#' }
#' #'
#' @importFrom magrittr %>% %T>% #' @importFrom magrittr %>% %T>%
#' @importFrom data.table := #' @importFrom data.table :=
......
R-package/R/lgb.interprete.R
View file @ 029bcc42
...@@ -17,8 +17,6 @@ ...@@ -17,8 +17,6 @@
#' For multiclass classification, a \code{list} of \code{data.table} with the Feature column and Contribution columns to each class. #' For multiclass classification, a \code{list} of \code{data.table} with the Feature column and Contribution columns to each class.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm)
#' Sigmoid <- function(x) 1 / (1 + exp(-x)) #' Sigmoid <- function(x) 1 / (1 + exp(-x))
#' Logit <- function(x) log(x / (1 - x)) #' Logit <- function(x) log(x / (1 - x))
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
...@@ -28,14 +26,17 @@ ...@@ -28,14 +26,17 @@
#' data(agaricus.test, package = "lightgbm") #' data(agaricus.test, package = "lightgbm")
#' test <- agaricus.test #' test <- agaricus.test
#' #'
#' params = list(objective = "binary", #' params <- list(
#' learning_rate = 0.01, num_leaves = 63, max_depth = -1, #' objective = "binary"
#' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1) #' , learning_rate = 0.01
#' model <- lgb.train(params, dtrain, 20) #' , num_leaves = 63
#' , max_depth = -1
#' , min_data_in_leaf = 1
#' , min_sum_hessian_in_leaf = 1
#' )
#' model <- lgb.train(params, dtrain, 20) #' model <- lgb.train(params, dtrain, 20)
#' #'
#' tree_interpretation <- lgb.interprete(model, test$data, 1:5) #' tree_interpretation <- lgb.interprete(model, test$data, 1:5)
#' }
#' #'
#' @importFrom magrittr %>% %T>% #' @importFrom magrittr %>% %T>%
#' @export #' @export
......
R-package/R/lgb.model.dt.tree.R
View file @ 029bcc42
...@@ -30,21 +30,18 @@ ...@@ -30,21 +30,18 @@
#' } #' }
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm)
#' #'
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
#' dtrain <- lgb.Dataset(train$data, label = train$label) #' dtrain <- lgb.Dataset(train$data, label = train$label)
#' #'
#' params = list(objective = "binary", #' params <- list(objective = "binary",
#' learning_rate = 0.01, num_leaves = 63, max_depth = -1, #' learning_rate = 0.01, num_leaves = 63, max_depth = -1,
#' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1) #' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1)
#' model <- lgb.train(params, dtrain, 20) #' model <- lgb.train(params, dtrain, 20)
#' model <- lgb.train(params, dtrain, 20) #' model <- lgb.train(params, dtrain, 20)
#' #'
#' tree_dt <- lgb.model.dt.tree(model) #' tree_dt <- lgb.model.dt.tree(model)
#' }
#' #'
#' @importFrom magrittr %>% #' @importFrom magrittr %>%
#' @importFrom data.table := data.table rbindlist #' @importFrom data.table := data.table rbindlist
......
R-package/R/lgb.plot.importance.R
View file @ 029bcc42
...@@ -17,20 +17,23 @@ ...@@ -17,20 +17,23 @@
#' and silently returns a processed data.table with \code{top_n} features sorted by defined importance. #' and silently returns a processed data.table with \code{top_n} features sorted by defined importance.
#' #'
#' @examples #' @examples
#' \dontrun{ # data(agaricus.train, package = "lightgbm")
#' data(agaricus.train, package = "lightgbm") # train <- agaricus.train
#' train <- agaricus.train # dtrain <- lgb.Dataset(train$data, label = train$label)
#' dtrain <- lgb.Dataset(train$data, label = train$label) #
#' # params <- list(
#' params = list(objective = "binary", # objective = "binary"
#' learning_rate = 0.01, num_leaves = 63, max_depth = -1, # , learning_rate = 0.01
#' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1) # , num_leaves = 63
#' model <- lgb.train(params, dtrain, 20) # , max_depth = -1
#' model <- lgb.train(params, dtrain, 20) # , min_data_in_leaf = 1
#' # , min_sum_hessian_in_leaf = 1
#' tree_imp <- lgb.importance(model, percentage = TRUE) # )
#' lgb.plot.importance(tree_imp, top_n = 10, measure = "Gain") #
#' } # model <- lgb.train(params, dtrain, 20)
#
# tree_imp <- lgb.importance(model, percentage = TRUE)
# lgb.plot.importance(tree_imp, top_n = 10, measure = "Gain")
#' @importFrom graphics barplot par #' @importFrom graphics barplot par
#' @export #' @export
lgb.plot.importance <- function(tree_imp, lgb.plot.importance <- function(tree_imp,
......
R-package/R/lgb.plot.interpretation.R
View file @ 029bcc42
...@@ -16,7 +16,6 @@ ...@@ -16,7 +16,6 @@
#' The \code{lgb.plot.interpretation} function creates a \code{barplot}. #' The \code{lgb.plot.interpretation} function creates a \code{barplot}.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' Sigmoid <- function(x) {1 / (1 + exp(-x))} #' Sigmoid <- function(x) {1 / (1 + exp(-x))}
#' Logit <- function(x) {log(x / (1 - x))} #' Logit <- function(x) {log(x / (1 - x))}
...@@ -27,7 +26,7 @@ ...@@ -27,7 +26,7 @@
#' data(agaricus.test, package = "lightgbm") #' data(agaricus.test, package = "lightgbm")
#' test <- agaricus.test #' test <- agaricus.test
#' #'
#' params = list(objective = "binary", #' params <- list(objective = "binary",
#' learning_rate = 0.01, num_leaves = 63, max_depth = -1, #' learning_rate = 0.01, num_leaves = 63, max_depth = -1,
#' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1) #' min_data_in_leaf = 1, min_sum_hessian_in_leaf = 1)
#' model <- lgb.train(params, dtrain, 20) #' model <- lgb.train(params, dtrain, 20)
...@@ -35,7 +34,6 @@ ...@@ -35,7 +34,6 @@
#' #'
#' tree_interpretation <- lgb.interprete(model, test$data, 1:5) #' tree_interpretation <- lgb.interprete(model, test$data, 1:5)
#' lgb.plot.interpretation(tree_interpretation[[1]], top_n = 10) #' lgb.plot.interpretation(tree_interpretation[[1]], top_n = 10)
#' }
#' @importFrom graphics barplot par #' @importFrom graphics barplot par
#' @export #' @export
lgb.plot.interpretation <- function(tree_interpretation_dt, lgb.plot.interpretation <- function(tree_interpretation_dt,
......
R-package/R/lgb.prepare.R
View file @ 029bcc42
...@@ -7,7 +7,6 @@ ...@@ -7,7 +7,6 @@
#' @return The cleaned dataset. It must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset. #' @return The cleaned dataset. It must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(iris) #' data(iris)
#' #'
...@@ -37,7 +36,6 @@ ...@@ -37,7 +36,6 @@
#' # $ Petal.Length: num 1.4 1.4 1.3 1.5 1.4 1.7 1.4 1.5 1.4 1.5 ... #' # $ Petal.Length: num 1.4 1.4 1.3 1.5 1.4 1.7 1.4 1.5 1.4 1.5 ...
#' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ... #' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ...
#' # $ Species : num 1 1 1 1 1 1 1 1 1 1 ... #' # $ Species : num 1 1 1 1 1 1 1 1 1 1 ...
#' }
#' #'
#' @export #' @export
lgb.prepare <- function(data) { lgb.prepare <- function(data) {
......
R-package/R/lgb.prepare2.R
View file @ 029bcc42
...@@ -7,7 +7,6 @@ ...@@ -7,7 +7,6 @@
#' @return The cleaned dataset. It must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset. #' @return The cleaned dataset. It must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(iris) #' data(iris)
#' #'
...@@ -19,7 +18,8 @@ ...@@ -19,7 +18,8 @@
#' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ... #' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ...
#' # $ Species : Factor w/ 3 levels "setosa","versicolor",..: 1 1 1 1 ... #' # $ Species : Factor w/ 3 levels "setosa","versicolor",..: 1 1 1 1 ...
#' #'
#' str(lgb.prepare2(data = iris)) # Convert all factors/chars to integer #' # Convert all factors/chars to integer
#' str(lgb.prepare2(data = iris))
#' # 'data.frame': 150 obs. of 5 variables: #' # 'data.frame': 150 obs. of 5 variables:
#' # $ Sepal.Length: num 5.1 4.9 4.7 4.6 5 5.4 4.6 5 4.4 4.9 ... #' # $ Sepal.Length: num 5.1 4.9 4.7 4.6 5 5.4 4.6 5 4.4 4.9 ...
#' # $ Sepal.Width : num 3.5 3 3.2 3.1 3.6 3.9 3.4 3.4 2.9 3.1 ... #' # $ Sepal.Width : num 3.5 3 3.2 3.1 3.6 3.9 3.4 3.4 2.9 3.1 ...
...@@ -38,8 +38,6 @@ ...@@ -38,8 +38,6 @@
#' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ... #' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ...
#' # $ Species : int 1 1 1 1 1 1 1 1 1 1 ... #' # $ Species : int 1 1 1 1 1 1 1 1 1 1 ...
#' #'
#' }
#'
#' @export #' @export
lgb.prepare2 <- function(data) { lgb.prepare2 <- function(data) {
......
R-package/R/lgb.prepare_rules.R
View file @ 029bcc42
...@@ -8,7 +8,6 @@ ...@@ -8,7 +8,6 @@
#' @return A list with the cleaned dataset (\code{data}) and the rules (\code{rules}). The data must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset. #' @return A list with the cleaned dataset (\code{data}) and the rules (\code{rules}). The data must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(iris) #' data(iris)
#' #'
...@@ -66,8 +65,6 @@ ...@@ -66,8 +65,6 @@
#' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ... #' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ...
#' # $ Species : num 3 3 3 3 3 3 3 3 3 3 ... #' # $ Species : num 3 3 3 3 3 3 3 3 3 3 ...
#' #'
#' }
#'
#' @importFrom data.table set #' @importFrom data.table set
#' @export #' @export
lgb.prepare_rules <- function(data, rules = NULL) { lgb.prepare_rules <- function(data, rules = NULL) {
......
R-package/R/lgb.prepare_rules2.R
View file @ 029bcc42
...@@ -8,7 +8,6 @@ ...@@ -8,7 +8,6 @@
#' @return A list with the cleaned dataset (\code{data}) and the rules (\code{rules}). The data must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset. #' @return A list with the cleaned dataset (\code{data}) and the rules (\code{rules}). The data must be converted to a matrix format (\code{as.matrix}) for input in lgb.Dataset.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(iris) #' data(iris)
#' #'
...@@ -66,8 +65,6 @@ ...@@ -66,8 +65,6 @@
#' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ... #' # $ Petal.Width : num 0.2 0.2 0.2 0.2 0.2 0.4 0.3 0.2 0.2 0.1 ...
#' # $ Species : int 3 3 3 3 3 3 3 3 3 3 ... #' # $ Species : int 3 3 3 3 3 3 3 3 3 3 ...
#' #'
#' }
#'
#' @importFrom data.table set #' @importFrom data.table set
#' @export #' @export
lgb.prepare_rules2 <- function(data, rules = NULL) { lgb.prepare_rules2 <- function(data, rules = NULL) {
......
R-package/R/lgb.train.R
View file @ 029bcc42
...@@ -26,7 +26,6 @@ ...@@ -26,7 +26,6 @@
#' @return a trained booster model \code{lgb.Booster}. #' @return a trained booster model \code{lgb.Booster}.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -43,7 +42,6 @@ ...@@ -43,7 +42,6 @@
#' min_data = 1, #' min_data = 1,
#' learning_rate = 1, #' learning_rate = 1,
#' early_stopping_rounds = 10) #' early_stopping_rounds = 10)
#' }
#' #'
#' @export #' @export
lgb.train <- function(params = list(), lgb.train <- function(params = list(),
......
R-package/R/lgb.unloader.R
View file @ 029bcc42
...@@ -9,7 +9,6 @@ ...@@ -9,7 +9,6 @@
#' @return NULL invisibly. #' @return NULL invisibly.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -32,7 +31,6 @@ ...@@ -32,7 +31,6 @@
#' #'
#' library(lightgbm) #' library(lightgbm)
#' # Do whatever you want again with LightGBM without object clashing #' # Do whatever you want again with LightGBM without object clashing
#' }
#' #'
#' @export #' @export
lgb.unloader <- function(restore = TRUE, wipe = FALSE, envir = .GlobalEnv) { lgb.unloader <- function(restore = TRUE, wipe = FALSE, envir = .GlobalEnv) {
......
R-package/R/readRDS.lgb.Booster.R
View file @ 029bcc42
...@@ -8,7 +8,6 @@ ...@@ -8,7 +8,6 @@
#' @return lgb.Booster. #' @return lgb.Booster.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -27,7 +26,6 @@ ...@@ -27,7 +26,6 @@
#' early_stopping_rounds = 10) #' early_stopping_rounds = 10)
#' saveRDS.lgb.Booster(model, "model.rds") #' saveRDS.lgb.Booster(model, "model.rds")
#' new_model <- readRDS.lgb.Booster("model.rds") #' new_model <- readRDS.lgb.Booster("model.rds")
#' }
#' #'
#' @export #' @export
readRDS.lgb.Booster <- function(file = "", refhook = NULL) { readRDS.lgb.Booster <- function(file = "", refhook = NULL) {
......
R-package/R/saveRDS.lgb.Booster.R
View file @ 029bcc42
...@@ -13,7 +13,6 @@ ...@@ -13,7 +13,6 @@
#' @return NULL invisibly. #' @return NULL invisibly.
#' #'
#' @examples #' @examples
#' \dontrun{
#' library(lightgbm) #' library(lightgbm)
#' data(agaricus.train, package = "lightgbm") #' data(agaricus.train, package = "lightgbm")
#' train <- agaricus.train #' train <- agaricus.train
...@@ -23,16 +22,16 @@ ...@@ -23,16 +22,16 @@
#' dtest <- lgb.Dataset.create.valid(dtrain, test$data, label = test$label) #' dtest <- lgb.Dataset.create.valid(dtrain, test$data, label = test$label)
#' params <- list(objective = "regression", metric = "l2") #' params <- list(objective = "regression", metric = "l2")
#' valids <- list(test = dtest) #' valids <- list(test = dtest)
#' model <- lgb.train(params, #' model <- lgb.train(
#' dtrain, #' params
#' 100, #' , dtrain
#' valids, #' , 100
#' min_data = 1, #' , valids
#' learning_rate = 1, #' , min_data = 1
#' early_stopping_rounds = 10) #' , learning_rate = 1
#' , early_stopping_rounds = 10
#' )
#' saveRDS.lgb.Booster(model, "model.rds") #' saveRDS.lgb.Booster(model, "model.rds")
#' }
#'
#' @export #' @export
saveRDS.lgb.Booster <- function(object, saveRDS.lgb.Booster <- function(object,
file = "", file = "",
......
R-package/man/dim.Rd
View file @ 029bcc42
...@@ -22,7 +22,6 @@ Note: since \code{nrow} and \code{ncol} internally use \code{dim}, they can also ...@@ -22,7 +22,6 @@ Note: since \code{nrow} and \code{ncol} internally use \code{dim}, they can also
be directly used with an \code{lgb.Dataset} object. be directly used with an \code{lgb.Dataset} object.
} }
\examples{ \examples{
\dontrun{
library(lightgbm) library(lightgbm)
data(agaricus.train, package = "lightgbm") data(agaricus.train, package = "lightgbm")
train <- agaricus.train train <- agaricus.train
...@@ -31,6 +30,5 @@ dtrain <- lgb.Dataset(train$data, label = train$label) ...@@ -31,6 +30,5 @@ dtrain <- lgb.Dataset(train$data, label = train$label)
stopifnot(nrow(dtrain) == nrow(train$data)) stopifnot(nrow(dtrain) == nrow(train$data))
stopifnot(ncol(dtrain) == ncol(train$data)) stopifnot(ncol(dtrain) == ncol(train$data))
stopifnot(all(dim(dtrain) == dim(train$data))) stopifnot(all(dim(dtrain) == dim(train$data)))
}
} }
R-package/man/dimnames.lgb.Dataset.Rd
View file @ 029bcc42
...@@ -24,7 +24,6 @@ Generic \code{dimnames} methods are used by \code{colnames}. ...@@ -24,7 +24,6 @@ Generic \code{dimnames} methods are used by \code{colnames}.
Since row names are irrelevant, it is recommended to use \code{colnames} directly. Since row names are irrelevant, it is recommended to use \code{colnames} directly.
} }
\examples{ \examples{
\dontrun{
library(lightgbm) library(lightgbm)
data(agaricus.train, package = "lightgbm") data(agaricus.train, package = "lightgbm")
train <- agaricus.train train <- agaricus.train
...@@ -34,6 +33,5 @@ dimnames(dtrain) ...@@ -34,6 +33,5 @@ dimnames(dtrain)
colnames(dtrain) colnames(dtrain)
colnames(dtrain) <- make.names(1:ncol(train$data)) colnames(dtrain) <- make.names(1:ncol(train$data))
print(dtrain, verbose = TRUE) print(dtrain, verbose = TRUE)
}
} }
R-package/man/getinfo.Rd
View file @ 029bcc42
...@@ -33,7 +33,6 @@ The \code{name} field can be one of the following: ...@@ -33,7 +33,6 @@ The \code{name} field can be one of the following:
} }
} }
\examples{ \examples{
\dontrun{
library(lightgbm) library(lightgbm)
data(agaricus.train, package = "lightgbm") data(agaricus.train, package = "lightgbm")
train <- agaricus.train train <- agaricus.train
...@@ -45,6 +44,5 @@ lightgbm::setinfo(dtrain, "label", 1 - labels) ...@@ -45,6 +44,5 @@ lightgbm::setinfo(dtrain, "label", 1 - labels)
labels2 <- lightgbm::getinfo(dtrain, "label") labels2 <- lightgbm::getinfo(dtrain, "label")
stopifnot(all(labels2 == 1 - labels)) stopifnot(all(labels2 == 1 - labels))
}
} }
R-package/man/lgb.Dataset.Rd
View file @ 029bcc42
...@@ -32,7 +32,6 @@ Construct lgb.Dataset object from dense matrix, sparse matrix ...@@ -32,7 +32,6 @@ Construct lgb.Dataset object from dense matrix, sparse matrix
or local file (that was created previously by saving an \code{lgb.Dataset}). or local file (that was created previously by saving an \code{lgb.Dataset}).
} }
\examples{ \examples{
\dontrun{
library(lightgbm) library(lightgbm)
data(agaricus.train, package = "lightgbm") data(agaricus.train, package = "lightgbm")
train <- agaricus.train train <- agaricus.train
...@@ -40,6 +39,5 @@ dtrain <- lgb.Dataset(train$data, label = train$label) ...@@ -40,6 +39,5 @@ dtrain <- lgb.Dataset(train$data, label = train$label)
lgb.Dataset.save(dtrain, "lgb.Dataset.data") lgb.Dataset.save(dtrain, "lgb.Dataset.data")
dtrain <- lgb.Dataset("lgb.Dataset.data") dtrain <- lgb.Dataset("lgb.Dataset.data")
lgb.Dataset.construct(dtrain) lgb.Dataset.construct(dtrain)
}
} }
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment