Skip to content

Commit 1cc0a44

Browse files
author
Qiang Kou
committed
[Doc] documents update:
(1) install_github is not support due to the usage of submodule (2) remove part of the markdown which is not displayed correctly, see https://xgboost.readthedocs.org/en/latest/R-package/discoverYourData.html
1 parent d063eac commit 1cc0a44

File tree

4 files changed

+21
-33
lines changed

4 files changed

+21
-33
lines changed

R-package/README.md

+11-6
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,24 @@ We are [on CRAN](https://cran.r-project.org/web/packages/xgboost/index.html) now
1919
install.packages('xgboost')
2020
```
2121

22-
For up-to-date version, please install from github. Windows user will need to install [RTools](http://cran.r-project.org/bin/windows/Rtools/) first.
23-
24-
```r
25-
devtools::install_git('git://github.com/dmlc/xgboost',subdir='R-package')
26-
```
27-
2822
You can also install from our weekly updated drat repo:
2923
```r
3024
install.packages("drat", repos="https://cran.rstudio.com")
3125
drat:::addRepo("dmlc")
3226
install.packages("xgboost", repos="http://dmlc.ml/drat/", type="source")
3327
```
3428

29+
***Important*** Due to the usage of submodule, `install_github` is no longer support to install the
30+
latest version of R package.
31+
For up-to-date version, please install from github. Windows user will need to install [RTools](http://cran.r-project.org/bin/windows/Rtools/) first.
32+
33+
```bash
34+
git clone --recursive https://github.com/dmlc/xgboost
35+
cd xgboost
36+
make Rbuild
37+
R CMD INSTALL xgboost_0.4-3.tar.gz
38+
```
39+
3540
For more detailed installation instructions, please see [here](http://xgboost.readthedocs.org/en/latest/build.html#r-package-installation).
3641

3742
Examples

doc/R-package/discoverYourData.md

-13
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,3 @@
1-
---
2-
title: "Understand your dataset with Xgboost"
3-
output:
4-
rmarkdown::html_vignette:
5-
css: vignette.css
6-
number_sections: yes
7-
toc: yes
8-
author: Tianqi Chen, Tong He, Michaël Benesty
9-
vignette: >
10-
%\VignetteIndexEntry{Discover your data}
11-
%\VignetteEngine{knitr::rmarkdown}
12-
\usepackage[utf8]{inputenc}
13-
---
141

152
Understand your dataset with XGBoost
163
====================================

doc/R-package/xgboostPresentation.md

-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
---
2-
title: "Xgboost presentation"
3-
output:
4-
rmarkdown::html_vignette:
5-
css: vignette.css
6-
number_sections: yes
7-
toc: yes
8-
bibliography: xgboost.bib
9-
author: Tianqi Chen, Tong He, Michaël Benesty
10-
vignette: >
11-
%\VignetteIndexEntry{Xgboost presentation}
12-
%\VignetteEngine{knitr::rmarkdown}
13-
\usepackage[utf8]{inputenc}
14-
---
151

162
XGBoost R Tutorial
173
==================

doc/build.md

+10
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,16 @@ First follow [Building on OSX](#building-on-osx) to get the OpenMP enabled compi
180180
install.packages("xgboost", repos="http://dmlc.ml/drat/", type = "source")
181181
```
182182

183+
Due to the usage of submodule, `install_github` is no longer support to install the
184+
latest version of R package. To install the latest version,
185+
186+
```bash
187+
git clone --recursive https://github.com/dmlc/xgboost
188+
cd xgboost
189+
make Rbuild
190+
R CMD INSTALL xgboost_0.4-3.tar.gz
191+
```
192+
183193
## Trouble Shooting
184194

185195
1. **Compile failed after `git pull`**

0 commit comments

Comments
 (0)