[R-package] [docs] Added documentation on lgb.dl() and data.table version (fixes #2715) (#2846)

* [R-package] [docs] Added documentation on lgb.dl() and data.table version

* added missed table of contents item

* moved known issues to FAQ docs

* fixed formatting

R-package/README.md

@@ -1,6 +1,14 @@
 LightGBM R-package
 ==================
 
+### Contents
+
+* [Installation](#installation)
+* [Examples](#examples)
+* [Testing](#testing)
+* [External Repositories](#external-unofficial-repositories)
+* [Known Issues](#known-issues)
+
 Installation
 ------------
 
@@ -156,3 +164,8 @@ External (Unofficial) Repositories
 Projects listed here are not maintained or endorsed by the `LightGBM` development team, but may offer some features currently missing from the main R package.
 
 * [lightgbm.py](https://github.com/kapsner/lightgbm.py): This R package offers a wrapper built with `reticulate`, a package used to call Python code from R. If you are comfortable with the added installation complexity of installing `lightgbm`'s Python package and the performance cost of passing data between R and Python, you might find that this package offers some features that are not yet available in the native `lightgbm` R package.
+
+Known Issues
+------------
+
+For information about known issues with the R package, see the [R-package section of LightGBM's main FAQ page](https://lightgbm.readthedocs.io/en/latest/FAQ.html#r-package).

docs/FAQ.rst

@@ -201,12 +201,17 @@ Run ``lgb.unloader(wipe = TRUE)`` in the R console, and recreate the LightGBM da
 Due to the pointers, choosing to not wipe variables will not fix the error.
 This is a known issue: `Microsoft/LightGBM#698 <https://github.com/microsoft/LightGBM/issues/698>`__.
 
-2. I used ``setinfo``, tried to print my ``lgb.Dataset``, and now the R console froze!
---------------------------------------------------------------------------------------
+2. I used ``setinfo()``, tried to print my ``lgb.Dataset``, and now the R console froze!
+----------------------------------------------------------------------------------------
 
 Avoid printing the ``lgb.Dataset`` after using ``setinfo``.
 This is a known bug: `Microsoft/LightGBM#539 <https://github.com/microsoft/LightGBM/issues/539>`__.
 
+3. ``error in data.table::data.table()...argument 2 is NULL``
+-------------------------------------------------------------
+
+If you experiencing this error when running `lightgbm`, you may be facing the same issue reported in `#2715 <https://github.com/microsoft/LightGBM/issues/2715>`_. If you use ``lgb.dl()`` to build from source (i.e. not using pre-compiled dll), you need to upgrade your version of ``data.table`` to at least version 1.12.0.
+
 ------
 
 Python-package