programming_languages:r:parameter_description

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
programming_languages:r:parameter_description [2017/03/19 19:37] – [train method] phreazerprogramming_languages:r:parameter_description [2017/03/19 20:50] – [Problem] phreazer
Line 4: Line 4:
  
 Issues: 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).+  * 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 too large (in particular the parameter description part).
   * The model description itself should be structured.   * The model description itself should be structured.
  
Line 35: Line 35:
  
   Usage:   Usage:
- 
      modelLookup(model = NULL)      modelLookup(model = NULL)
            
Line 49: Line 48:
  
   Value:   Value:
- +   ‘modelLookup’ produces a data frame with columns 
-     ‘modelLookup’ produces a data frame with columns +   
    model: a character string for the model code    model: a character string for the model code
 +   
    parameter : the tuning parameter name    parameter : the tuning parameter name
 +   
    label : a tuning parameter label (used in plots)    label : a tuning parameter label (used in plots)
 +   
    forReg : a logical; can the model be used for regression?    forReg : a logical; can the model be used for regression?
 +   
    forClass : a logical; can the model be used for classification?    forClass : a logical; can the model be used for classification?
 +   
    probModel : a logical; does the model produce class probabilities?    probModel : a logical; does the model produce class probabilities?
      ‘getModelInfo’ returns a list containing one or more lists of the      ‘getModelInfo’ returns a list containing one or more lists of the
      standard model information.      standard model information.
- +   
-     ‘checkInstall’ returns not value. +
 Returned info from getModelInfo is a rather cryptic list. Returned info from getModelInfo is a rather cryptic list.
  
  • programming_languages/r/parameter_description.txt
  • Last modified: 2017/03/26 20:26
  • by phreazer