[R-package] docs for lgb.Dataset in R are incomplete

[david-cortes]

In the R package, the function lgb.Dataset has a parameter categorical_feature, with this description:

categorical features

LightGBM/R-package/R/lgb.Dataset.R

Line 736 in 7ea2bc4

#' @param categorical_feature categorical features

It does not describe what kind of input it needs to be, in contrast to lgb.Dataset.set.categorical.

[jameslamb]

Thanks for using {lightgbm} and for looking into the documentation.

In this case, the parameter categorical_feature can be either:

1. A character vector of feature names
2. A numeric or integer vector of column indices (1-based, so e.g. "3" would mean "the third column")

Are you interested in contributing some improvements to the R package's documentation? If you are, we would be really grateful for the help! If not, then no problem at all and I can update this documentation soon.

[david-cortes]

Thanks but I'll pass on that as I'm not really familiar with it.

BTW I notice it's missing the docs for allowed parameters.

[jameslamb]

Ok no problem. Can you please clarify what you mean by "allowed parameters"?

[david-cortes]

Ok no problem. Can you please clarify what you mean by "allowed parameters"?

Functions lightgbm, lgb.train, lgb.cv, have an argument params which says: List of parameters.

[jameslamb]

I see, ok. Yes we should be linking to https://lightgbm.readthedocs.io/en/latest/Parameters.html in those places.

[github-actions]

This issue has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.