From 1cc0a442644508cd7517727e5231b1cec0ffaa2e Mon Sep 17 00:00:00 2001 From: Qiang Kou Date: Tue, 23 Feb 2016 14:42:52 -0500 Subject: [PATCH] [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 --- R-package/README.md | 17 +++++++++++------ doc/R-package/discoverYourData.md | 13 ------------- doc/R-package/xgboostPresentation.md | 14 -------------- doc/build.md | 10 ++++++++++ 4 files changed, 21 insertions(+), 33 deletions(-) diff --git a/R-package/README.md b/R-package/README.md index ba1d6edba..b94f50af6 100644 --- a/R-package/README.md +++ b/R-package/README.md @@ -19,12 +19,6 @@ We are [on CRAN](https://cran.r-project.org/web/packages/xgboost/index.html) now install.packages('xgboost') ``` -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. - -```r -devtools::install_git('git://github.com/dmlc/xgboost',subdir='R-package') -``` - You can also install from our weekly updated drat repo: ```r install.packages("drat", repos="https://cran.rstudio.com") @@ -32,6 +26,17 @@ drat:::addRepo("dmlc") install.packages("xgboost", repos="http://dmlc.ml/drat/", type="source") ``` +***Important*** Due to the usage of submodule, `install_github` is no longer support to install the +latest version of R package. +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. + +```bash +git clone --recursive https://github.com/dmlc/xgboost +cd xgboost +make Rbuild +R CMD INSTALL xgboost_0.4-3.tar.gz +``` + For more detailed installation instructions, please see [here](http://xgboost.readthedocs.org/en/latest/build.html#r-package-installation). Examples diff --git a/doc/R-package/discoverYourData.md b/doc/R-package/discoverYourData.md index e5327b8fc..e796c114d 100644 --- a/doc/R-package/discoverYourData.md +++ b/doc/R-package/discoverYourData.md @@ -1,16 +1,3 @@ ---- -title: "Understand your dataset with Xgboost" -output: - rmarkdown::html_vignette: - css: vignette.css - number_sections: yes - toc: yes -author: Tianqi Chen, Tong He, Michaël Benesty -vignette: > - %\VignetteIndexEntry{Discover your data} - %\VignetteEngine{knitr::rmarkdown} - \usepackage[utf8]{inputenc} ---- Understand your dataset with XGBoost ==================================== diff --git a/doc/R-package/xgboostPresentation.md b/doc/R-package/xgboostPresentation.md index 4623c6c55..9b8775c96 100644 --- a/doc/R-package/xgboostPresentation.md +++ b/doc/R-package/xgboostPresentation.md @@ -1,17 +1,3 @@ ---- -title: "Xgboost presentation" -output: - rmarkdown::html_vignette: - css: vignette.css - number_sections: yes - toc: yes -bibliography: xgboost.bib -author: Tianqi Chen, Tong He, Michaël Benesty -vignette: > - %\VignetteIndexEntry{Xgboost presentation} - %\VignetteEngine{knitr::rmarkdown} - \usepackage[utf8]{inputenc} ---- XGBoost R Tutorial ================== diff --git a/doc/build.md b/doc/build.md index bfe9e6b2b..f3e2490bb 100644 --- a/doc/build.md +++ b/doc/build.md @@ -180,6 +180,16 @@ First follow [Building on OSX](#building-on-osx) to get the OpenMP enabled compi install.packages("xgboost", repos="http://dmlc.ml/drat/", type = "source") ``` +Due to the usage of submodule, `install_github` is no longer support to install the +latest version of R package. To install the latest version, + +```bash +git clone --recursive https://github.com/dmlc/xgboost +cd xgboost +make Rbuild +R CMD INSTALL xgboost_0.4-3.tar.gz +``` + ## Trouble Shooting 1. **Compile failed after `git pull`**