org.apache.spark.ml.feature

Class RFormula

Object

org.apache.spark.ml.PipelineStage

org.apache.spark.ml.Estimator<RFormulaModel>

org.apache.spark.ml.feature.RFormula

All Implemented Interfaces:

java.io.Serializable, Logging, Params, Identifiable

public class RFormula
extends Estimator<RFormulaModel>

:: Experimental :: Implements the transforms required for fitting a dataset against an R model formula. Currently we support a limited subset of the R operators, including '~', '.', ':', '+', and '-'. Also see the R formula docs here: http://stat.ethz.ch/R-manual/R-patched/library/stats/html/formula.html

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RFormula()
RFormula(String uid)

Method Summary

Methods

Modifier and Type	Method and Description
RFormula	copy(ParamMap extra) Creates a copy of this instance with the same UID and some extra params.
RFormulaModel	fit(DataFrame dataset) Fits a model to the input data.
Param<String>	formula() R formula parameter.
String	getFormula()
boolean	hasLabelCol(StructType schema)
RFormula	setFeaturesCol(String value)
RFormula	setFormula(String value) Sets the formula to use for this transformer.
RFormula	setLabelCol(String value)
String	toString()
StructType	transformSchema(StructType schema) :: DeveloperApi ::
String	uid() An immutable unique ID for the object and its derivatives.

Methods inherited from class org.apache.spark.ml.Estimator

fit, fit, fit, fit

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.spark.ml.param.Params

clear, copyValues, defaultCopy, defaultParamMap, explainParam, explainParams, extractParamMap, extractParamMap, get, getDefault, getOrDefault, getParam, hasDefault, hasParam, isDefined, isSet, paramMap, params, set, set, set, setDefault, setDefault, shouldOwn, validateParams

Methods inherited from interface org.apache.spark.Logging

initializeIfNecessary, initializeLogging, isTraceEnabled, log_, log, logDebug, logDebug, logError, logError, logInfo, logInfo, logName, logTrace, logTrace, logWarning, logWarning

Constructor Detail

RFormula

public RFormula(String uid)

RFormula

public RFormula()

Method Detail

uid

public String uid()

Description copied from interface: Identifiable

An immutable unique ID for the object and its derivatives.

Specified by:

uid in interface Identifiable

Returns:

(undocumented)

formula

public Param<String> formula()

R formula parameter. The formula is provided in string form.

Returns:

(undocumented)

setFormula

public RFormula setFormula(String value)

Sets the formula to use for this transformer. Must be called before use.

Parameters:

value - an R formula in string form (e.g. "y ~ x + z")

Returns:

(undocumented)

getFormula

public String getFormula()

setFeaturesCol

public RFormula setFeaturesCol(String value)

setLabelCol

public RFormula setLabelCol(String value)

fit

public RFormulaModel fit(DataFrame dataset)

Description copied from class: Estimator

Fits a model to the input data.

Specified by:

fit in class Estimator<RFormulaModel>

Parameters:

dataset - (undocumented)

Returns:

(undocumented)

transformSchema

public StructType transformSchema(StructType schema)

Description copied from class: PipelineStage

:: DeveloperApi ::

Derives the output schema from the input schema.

Specified by:

transformSchema in class PipelineStage

Parameters:

schema - (undocumented)

Returns:

(undocumented)

copy

public RFormula copy(ParamMap extra)

Description copied from interface: Params

Creates a copy of this instance with the same UID and some extra params. Subclasses should implement this method and set the return type properly.

Specified by:

copy in interface Params

Specified by:

copy in class Estimator<RFormulaModel>

Parameters:

extra - (undocumented)

Returns:

(undocumented)

See Also:

defaultCopy()

toString

public String toString()

Specified by:

toString in interface Identifiable

Overrides:

toString in class Object

hasLabelCol

public boolean hasLabelCol(StructType schema)