dials icon indicating copy to clipboard operation
dials copied to clipboard

Allowed parameter documentation is ... sparse

Open alexpghayes opened this issue 6 years ago • 1 comments

I had a really hard time figuring out what acceptable values are for parameters. Often times the documentation is unclear with regards to:

  • Acceptable type
  • Bounds on numerics

Beyond allowed values, some heuristics on what reasonable values are would also be valuable.

Occasionally categorical values aren't listed out either. Consider prune_method in mars, which only refers the user to earth::earth() without cross-linking the documentation.

On the whole, I strongly recommend a major update to the parameter documentation to add additional detail.

alexpghayes avatar Apr 10 '19 03:04 alexpghayes

The current dev docs have more details

topepo avatar Aug 05 '19 22:08 topepo