programming_languages:r:parameter_description

This is an old revision of the document!


Problem

Some R packages provide generic functions e.g. for training models, calculating distances, etc., where one model out of a set of various possible models has to be chosen as a parameter of the function.

Issues:

  • Documenting the possible entries is not easy, because a single model description already contains a lot of information. When many models must be described in help, the help page of the function becomes to large (in particular the parameter description part).
  • The model description itself should be structured.

Existing solutions

How is this problem solved by different popular packages?

method: a string specifying which classification or regression model
        to use. Possible values are found using
        ‘names(getModelInfo())’. See <URL:
        http://topepo.github.io/caret/bytag.html>. A list of
        functions can also be passed for a custom model function. See
        <URL: http://topepo.github.io/caret/custom_models.html> for
        details.
  • programming_languages/r/parameter_description.1489947421.txt.gz
  • Last modified: 2017/03/19 19:17
  • by phreazer