lgb.prepare2.Rd 1.54 KB
Newer Older
James Lamb's avatar
James Lamb committed
1
2
3
4
5
6
7
8
9
10
11
12
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lgb.prepare2.R
\name{lgb.prepare2}
\alias{lgb.prepare2}
\title{Data preparator for LightGBM datasets (integer)}
\usage{
lgb.prepare2(data)
}
\arguments{
\item{data}{A data.frame or data.table to prepare.}
}
\value{
13
14
The cleaned dataset. It must be converted to a matrix format (\code{as.matrix})
        for input in \code{lgb.Dataset}.
James Lamb's avatar
James Lamb committed
15
16
}
\description{
17
18
19
20
21
22
Attempts to prepare a clean dataset to prepare to put in a \code{lgb.Dataset}.
Factors and characters are converted to numeric (specifically: integer).
Please use \code{lgb.prepare_rules2} if you want to apply this transformation to other datasets.
This is useful if you have a specific need for integer dataset instead of numeric dataset.
Note that there are programs which do not support integer-only input. Consider this as a half
memory technique which is dangerous, especially for LightGBM.
James Lamb's avatar
James Lamb committed
23
24
25
26
27
28
29
}
\examples{
library(lightgbm)
data(iris)

str(iris)

30
31
# Convert all factors/chars to integer
str(lgb.prepare2(data = iris))
James Lamb's avatar
James Lamb committed
32

Nikita Titov's avatar
Nikita Titov committed
33
\dontrun{
James Lamb's avatar
James Lamb committed
34
35
36
37
38
39
40
41
42
43
# When lightgbm package is installed, and you do not want to load it
# You can still use the function!
lgb.unloader()
str(lightgbm::lgb.prepare2(data = iris))
# '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.Width : num  3.5 3 3.2 3.1 3.6 3.9 3.4 3.4 2.9 3.1 ...
# $ 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 ...
# $ Species     : int  1 1 1 1 1 1 1 1 1 1 ...
Nikita Titov's avatar
Nikita Titov committed
44
}
James Lamb's avatar
James Lamb committed
45
46

}