MLRClassifierImpl

java.lang.Object
- weka.classifiers.mlr.impl.MLRClassifierImpl

All Implemented Interfaces:

java.io.Serializable, BatchPredictor, CapabilitiesHandler, OptionHandler, RevisionHandler
```
public class MLRClassifierImpl
extends java.lang.Object
implements BatchPredictor, OptionHandler, CapabilitiesHandler, RevisionHandler, java.io.Serializable
```
Implementation class for a wrapper classifier for the MLR R library:

http://cran.r-project.org/web/packages/mlr/
The class will attempt to install and load the MLR library if it is not already present in the user's R environment. Similarly, it will attempt to install and load specific base learners as required.
The classifier supports serialization by serializing to binary inside of R, retrieving the serialized classifier via the JRI native interface to R and then finally serializing the JRI REXP object to XML using XStream. The last step is required because JRI REXP objects do not implement Serializable.

Version:

$Revision: 12239 $

Author:

Mark Hall (mhall{[at]}pentaho{[dot]}com)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

MLRClassifierImpl()

Constructors
Constructor and Description
`MLRClassifierImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`batchSizeTipText()` Returns the tip text for this property
`void`	`buildClassifier(Instances data)` Build the specified R learner on the incoming training data.
`void`	`closeREngine()` Close the R environment down.
`java.lang.String`	`debugTipText()` Returns the tip text for this property
`double[]`	`distributionForInstance(Instance inst)` Calculates the class membership probabilities for the given test instance.
`double[][]`	`distributionsForInstances(Instances insts)` Batch scoring method
`java.lang.String`	`dontReplaceMissingValuesTipText()` Returns the tip text for this property
`java.lang.String`	`getBatchSize()` Get the batch size for prediction (i.e.
`Capabilities`	`getCapabilities()` Returns default capabilities of the classifier.
`boolean`	`getDebug()` Get whether to output debugging info
`boolean`	`getDontReplaceMissingValues()` Get whether to turn off replacement of missing values in the data before it is passed into R.
`java.lang.String`	`getLearnerParams()` Get the parameters for the R learner.
`boolean`	`getLogMessagesFromR()` Get whether to log info/warning messages from R to the console.
`java.lang.String[]`	`getOptions()` Gets the current settings of MLRClassifier.
`java.lang.String`	`getRevision()` Returns the revision string.
`SelectedTag`	`getRLearner()` Get the base R learner to use
`int`	`getSeed()` Gets the seed for the random number generations
`java.lang.String`	`globalInfo()` Global info for this wrapper classifier.
`boolean`	`implementsMoreEfficientBatchPrediction()` Returns true, as R schemes have to predict in batches and we push entire test sets over into R
`java.lang.String`	`learnerParamsTipText()` Returns the tip text for this property
`java.util.Enumeration<Option>`	`listOptions()` Returns an enumeration describing the available options.
`java.lang.String`	`logMessagesFromRTipText()` Returns the tip text for this property
`java.lang.String`	`RLearnerTipText()` Returns the tip text for this property
`java.lang.String`	`seedTipText()` Returns the tip text for this property
`void`	`setBatchSize(java.lang.String size)` Set the batch size for prediction (i.e.
`void`	`setDebug(boolean d)` Set whether to output debugging info
`void`	`setDontReplaceMissingValues(boolean d)` Set whether to turn off replacement of missing values in the data before it is passed into R.
`void`	`setLearnerParams(java.lang.String learnerParams)` Set the parameters for the R learner.
`void`	`setLogMessagesFromR(boolean l)` Set whether to log info/warning messages from R to the console.
`void`	`setOptions(java.lang.String[] options)` Parses a given list of options.
`void`	`setRLearner(SelectedTag learner)` Set the base R learner to use
`void`	`setSeed(int seed)` Set the seed for random number generation.
`java.lang.String`	`toString()` Returns the textual description of the R classifier.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MLRClassifierImpl
```
public MLRClassifierImpl()
```
- Method Detail
  - globalInfo
```
public java.lang.String globalInfo()
```
    Global info for this wrapper classifier.
    
    Returns:
    
    the global info suitable for displaying in the GUI.
  - getCapabilities
```
public Capabilities getCapabilities()
```
    Returns default capabilities of the classifier.
    
    Specified by:
    
    getCapabilities in interface CapabilitiesHandler
    
    Returns:
    
    the capabilities of this classifier
  - listOptions
```
public java.util.Enumeration<Option> listOptions()
```
    Returns an enumeration describing the available options.
    
    Specified by:
    
    listOptions in interface OptionHandler
    
    Returns:
    
    an enumeration of all the available options.
  - setOptions
```
public void setOptions(java.lang.String[] options)
                throws java.lang.Exception
```
    Parses a given list of options.
    
    Specified by:
    
    setOptions in interface OptionHandler
    
    Throws:
    
    java.lang.Exception
  - getOptions
```
public java.lang.String[] getOptions()
```
    Gets the current settings of MLRClassifier.
    
    Specified by:
    
    getOptions in interface OptionHandler
    
    Returns:
    
    an array of strings suitable for passing to setOptions()
  - debugTipText
```
public java.lang.String debugTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setDebug
```
public void setDebug(boolean d)
```
    Set whether to output debugging info
    
    Parameters:
    
    d - true if debugging info is to be output
  - getDebug
```
public boolean getDebug()
```
    Get whether to output debugging info
    
    Returns:
    
    true if debugging info is to be output
  - batchSizeTipText
```
public java.lang.String batchSizeTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - getBatchSize
```
public java.lang.String getBatchSize()
```
    Get the batch size for prediction (i.e. how many instances to push over into an R data frame at a time).
    
    Specified by:
    
    getBatchSize in interface BatchPredictor
    
    Returns:
    
    the batch size for prediction
  - setBatchSize
```
public void setBatchSize(java.lang.String size)
```
    Set the batch size for prediction (i.e. how many instances to push over into an R data frame at a time).
    
    Specified by:
    
    setBatchSize in interface BatchPredictor
  - implementsMoreEfficientBatchPrediction
```
public boolean implementsMoreEfficientBatchPrediction()
```
    Returns true, as R schemes have to predict in batches and we push entire test sets over into R
    
    Specified by:
    
    implementsMoreEfficientBatchPrediction in interface BatchPredictor
    
    Returns:
    
    true
  - RLearnerTipText
```
public java.lang.String RLearnerTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setRLearner
```
public void setRLearner(SelectedTag learner)
```
    Set the base R learner to use
    
    Parameters:
    
    learner - the learner to use
  - getRLearner
```
public SelectedTag getRLearner()
```
    Get the base R learner to use
    
    Returns:
    
    the learner to use
  - learnerParamsTipText
```
public java.lang.String learnerParamsTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setLearnerParams
```
public void setLearnerParams(java.lang.String learnerParams)
```
    Set the parameters for the R learner. This should be specified in the same way (i.e. comma separated) as they would be if using the R console.
    
    Parameters:
    
    learnerParams - the parameters (comma separated) to pass to the R learner.
  - getLearnerParams
```
public java.lang.String getLearnerParams()
```
    Get the parameters for the R learner. This should be specified in the same way (i.e. comma separated) as they would be if using the R console.
    
    Returns:
    
    the parameters (comma separated) to pass to the R learner.
  - dontReplaceMissingValuesTipText
```
public java.lang.String dontReplaceMissingValuesTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setDontReplaceMissingValues
```
public void setDontReplaceMissingValues(boolean d)
```
    Set whether to turn off replacement of missing values in the data before it is passed into R.
    
    Parameters:
    
    d - true if missing values should not be replaced.
  - getDontReplaceMissingValues
```
public boolean getDontReplaceMissingValues()
```
    Get whether to turn off replacement of missing values in the data before it is passed into R.
    
    Returns:
    
    true if missing values should not be replaced.
  - logMessagesFromRTipText
```
public java.lang.String logMessagesFromRTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setLogMessagesFromR
```
public void setLogMessagesFromR(boolean l)
```
    Set whether to log info/warning messages from R to the console.
    
    Parameters:
    
    l - true if info/warning messages should be logged to the console.
  - getLogMessagesFromR
```
public boolean getLogMessagesFromR()
```
    Get whether to log info/warning messages from R to the console.
    
    Returns:
    
    true if info/warning messages should be logged to the console.
  - seedTipText
```
public java.lang.String seedTipText()
```
    Returns the tip text for this property
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui
  - setSeed
```
public void setSeed(int seed)
```
    Set the seed for random number generation.
    
    Parameters:
    
    seed - the seed
  - getSeed
```
public int getSeed()
```
    Gets the seed for the random number generations
    
    Returns:
    
    the seed for the random number generation
  - buildClassifier
```
public void buildClassifier(Instances data)
                     throws java.lang.Exception
```
    Build the specified R learner on the incoming training data.
    
    Parameters:
    
    data - the training data to be used for generating the R model.
    
    Throws:
    
    java.lang.Exception - if the classifier could not be built successfully.
  - distributionsForInstances
```
public double[][] distributionsForInstances(Instances insts)
                                     throws java.lang.Exception
```
    Batch scoring method
    
    Specified by:
    
    distributionsForInstances in interface BatchPredictor
    
    Parameters:
    
    insts - the instances to push over to R and get predictions for
    
    Returns:
    
    an array of probability distributions, one for each instance
    
    Throws:
    
    java.lang.Exception - if a problem occurs
  - distributionForInstance
```
public double[] distributionForInstance(Instance inst)
                                 throws java.lang.Exception
```
    Calculates the class membership probabilities for the given test instance.
    
    Parameters:
    
    inst - the instance to be classified
    
    Returns:
    
    predicted class probability distribution
    
    Throws:
    
    java.lang.Exception - if distribution can't be computed successfully
  - closeREngine
```
public void closeREngine()
```
    Close the R environment down. This is useful when running from the command line in order to get control back.
  - toString
```
public java.lang.String toString()
```
    Returns the textual description of the R classifier.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    description of the R classifier as a string.
  - getRevision
```
public java.lang.String getRevision()
```
    Returns the revision string.
    
    Specified by:
    
    getRevision in interface RevisionHandler
    
    Returns:
    
    the revision

Class MLRClassifierImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MLRClassifierImpl

Method Detail

globalInfo

getCapabilities

listOptions

setOptions

getOptions

debugTipText

setDebug

getDebug

batchSizeTipText

getBatchSize

setBatchSize

implementsMoreEfficientBatchPrediction

RLearnerTipText

setRLearner

getRLearner

learnerParamsTipText

setLearnerParams

getLearnerParams

dontReplaceMissingValuesTipText

setDontReplaceMissingValues

getDontReplaceMissingValues

logMessagesFromRTipText

setLogMessagesFromR

getLogMessagesFromR

seedTipText

setSeed

getSeed

buildClassifier

distributionsForInstances

distributionForInstance

closeREngine

toString

getRevision