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
......@@ -20,7 +20,6 @@ NULL invisibly.
Attempts to unload LightGBM packages so you can remove objects cleanly without having to restart R. This is useful for instance if an object becomes stuck for no apparent reason and you do not want to restart R to fix the lost object.
}
\examples{
\dontrun{
library(lightgbm)
data(agaricus.train, package = "lightgbm")
train <- agaricus.train
......@@ -43,6 +42,5 @@ gc() # Not needed if wipe = TRUE
library(lightgbm)
# Do whatever you want again with LightGBM without object clashing
}
}
......@@ -44,7 +44,6 @@ number of columns corresponding to the number of trees.
Predicted values based on class \code{lgb.Booster}
}
\examples{
\dontrun{
library(lightgbm)
data(agaricus.train, package = "lightgbm")
train <- agaricus.train
......@@ -62,6 +61,5 @@ model <- lgb.train(params,
learning_rate = 1,
early_stopping_rounds = 10)
preds <- predict(model, test$data)
}
}
......@@ -18,7 +18,6 @@ lgb.Booster.
Attempts to load a model using RDS.
}
\examples{
\dontrun{
library(lightgbm)
data(agaricus.train, package = "lightgbm")
train <- agaricus.train
......@@ -37,6 +36,5 @@ model <- lgb.train(params,
early_stopping_rounds = 10)
saveRDS.lgb.Booster(model, "model.rds")
new_model <- readRDS.lgb.Booster("model.rds")
}
}
......@@ -29,7 +29,6 @@ NULL invisibly.
Attempts to save a model using RDS. Has an additional parameter (\code{raw}) which decides whether to save the raw model or not.
}
\examples{
\dontrun{
library(lightgbm)
data(agaricus.train, package = "lightgbm")
train <- agaricus.train
......@@ -39,14 +38,14 @@ test <- agaricus.test
dtest <- lgb.Dataset.create.valid(dtrain, test$data, label = test$label)
params <- list(objective = "regression", metric = "l2")
valids <- list(test = dtest)
model <- lgb.train(params,
dtrain,
100,
valids,
min_data = 1,
learning_rate = 1,
early_stopping_rounds = 10)
model <- lgb.train(
params
, dtrain
, 100
, valids
, min_data = 1
, learning_rate = 1
, early_stopping_rounds = 10
)
saveRDS.lgb.Booster(model, "model.rds")
}
}
......@@ -35,7 +35,6 @@ The \code{name} field can be one of the following:
}
}
\examples{
\dontrun{
library(lightgbm)
data(agaricus.train, package = "lightgbm")
train <- agaricus.train
......@@ -47,6 +46,5 @@ lightgbm::setinfo(dtrain, "label", 1 - labels)
labels2 <- lightgbm::getinfo(dtrain, "label")
stopifnot(all.equal(labels2, 1 - labels))
}
}
......@@ -24,14 +24,13 @@ Get a new \code{lgb.Dataset} containing the specified rows of
original lgb.Dataset object
}
\examples{
\dontrun{
library(lightgbm)
data(agaricus.train, package = "lightgbm")
train <- agaricus.train
dtrain <- lgb.Dataset(train$data, label = train$label)
dsub <- lightgbm::slice(dtrain, 1:42)
lgb.Dataset.construct(dsub)
labels <- lightgbm::getinfo(dsub, "label")
}
}
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