#################
XGBoost R Package
#################

.. raw:: html

  <a href="http://cran.r-project.org/web/packages/xgboost"><img alt="CRAN Status Badge" src="http://www.r-pkg.org/badges/version/xgboost"></a>
  <a href="http://cran.rstudio.com/web/packages/xgboost/index.html"><img alt="CRAN Downloads" src="http://cranlogs.r-pkg.org/badges/xgboost"></a>

You have found the XGBoost R Package!

.. toctree::
  :maxdepth: 2
  :titlesonly:

***********
Get Started
***********

Since XGBoost 3.0.0, the latest R package is available on `R-universe
<https://dmlc.r-universe.dev/xgboost>`__ while the one on CRAN is kept at an older
version. We will work on helping the CRAN version to catch up in the future. In the
meantime, please use R-universe packages.

* Check out the :doc:`Installation Guide </install>` for instructions on how to install
  xgboost, and :doc:`Tutorials </tutorials/index>` for examples on how to use XGBoost for
  various tasks.
* Read the latest `API documentation <../r_docs/R-package/docs/reference/index.html>`__.
* Read the `CRAN documentation <https://cran.r-project.org/web/packages/xgboost/xgboost.pdf>`_. (outdated)

*********
Vignettes
*********

.. toctree::

  xgboost_introduction
  xgboostfromJSON

************
Other topics
************

.. toctree::

  Migrating code from previous XGBoost versions <migration_guide>
  Handling of indexable elements <index_base>
  Developer guide: parameters from core library <adding_parameters>
