altair.RegressionTransform#
- class altair.RegressionTransform(on=Undefined, regression=Undefined, extent=Undefined, groupby=Undefined, method=Undefined, order=Undefined, params=Undefined, **kwds)#
RegressionTransform schema wrapper.
- Parameters:
- onstr,
FieldName The data field of the independent variable to use a predictor.
- regressionstr,
FieldName The data field of the dependent variable to predict.
- extentSequence[float]
A [min, max] domain over the independent (x) field for the starting and ending points of the generated trend line.
- groupbySequence[str,
FieldName] The data fields to group by. If not specified, a single group containing all data objects will be used.
- methodLiteral[‘linear’, ‘log’, ‘exp’, ‘pow’, ‘quad’, ‘poly’]
The functional form of the regression model. One of
"linear","log","exp","pow","quad", or"poly".Default value:
"linear"- orderfloat
The polynomial order (number of coefficients) for the ‘poly’ method.
Default value:
3- paramsbool
A boolean flag indicating if the transform should return the regression model parameters (one object per group), rather than trend line points. The resulting objects include a
coefarray of fitted coefficient values (starting with the intercept term and then including terms of increasing order) and anrSquaredvalue (indicating the total variance explained by the model).Default value:
false- asSequence[str,
FieldName] The output field names for the smoothed points generated by the regression transform.
Default value: The field names of the input x and y values.
- onstr,
- __init__(on=Undefined, regression=Undefined, extent=Undefined, groupby=Undefined, method=Undefined, order=Undefined, params=Undefined, **kwds)#
Methods
__init__([on, regression, extent, groupby, ...])copy([deep, ignore])Return a copy of the object.
from_dict(dct[, validate])Construct class from a dictionary representation.
from_json(json_string[, validate])Instantiate the object from a valid JSON string.
resolve_references([schema])Resolve references in the context of this object's schema or root schema.
to_dict([validate, ignore, context])Return a dictionary representation of the object.
to_json([validate, indent, sort_keys, ...])Emit the JSON representation for this object as a string.
validate(instance[, schema])Validate the instance against the class schema in the context of the rootschema.
validate_property(name, value[, schema])Validate a property against property schema in the context of the rootschema.