altair.ImputeTransform¶
-
class
altair.
ImputeTransform
(impute=Undefined, key=Undefined, frame=Undefined, groupby=Undefined, keyvals=Undefined, method=Undefined, value=Undefined, **kwds)¶ ImputeTransform schema wrapper
Mapping(required=[impute, key])
- Attributes
- impute
FieldName
The data field for which the missing values should be imputed.
- key
FieldName
A key field that uniquely identifies data objects within a group. Missing key values (those occurring in the data but not in the current group) will be imputed.
- frameList([anyOf(None, float), anyOf(None, float)])
A frame specification as a two-element array used to control the window over which the specified method is applied. The array entries should either be a number indicating the offset from the current data object, or null to indicate unbounded rows preceding or following the current data object. For example, the value
[-5, 5]
indicates that the window should include five objects preceding and five objects following the current object.Default value: :
[null, null]
indicating that the window includes all objects.- groupbyList(
FieldName
) An optional array of fields by which to group the values. Imputation will then be performed on a per-group basis.
- keyvalsanyOf(List(Any),
ImputeSequence
) Defines the key values that should be considered for imputation. An array of key values or an object defining a number sequence.
If provided, this will be used in addition to the key values observed within the input data. If not provided, the values will be derived from all unique values of the
key
field. Forimpute
inencoding
, the key field is the x-field if the y-field is imputed, or vice versa.If there is no impute grouping, this property must be specified.
- method
ImputeMethod
The imputation method to use for the field value of imputed data objects. One of
"value"
,"mean"
,"median"
,"max"
or"min"
.Default value:
"value"
- valueAny
The field value to use when the imputation
method
is"value"
.
- impute
-
__init__
(self, impute=Undefined, key=Undefined, frame=Undefined, groupby=Undefined, keyvals=Undefined, method=Undefined, value=Undefined, **kwds)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__
(self[, impute, key, frame, …])Initialize self.
copy
(self[, deep, ignore])Return a copy of the object
from_dict
(dct[, validate, _wrapper_classes])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
(self[, validate, ignore, context])Return a dictionary representation of the object
to_json
(self[, validate, ignore, context, …])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
-
copy
(self, deep=True, ignore=())¶ Return a copy of the object
- Parameters
- deepboolean or list, optional
If True (default) then return a deep copy of all dict, list, and SchemaBase objects within the object structure. If False, then only copy the top object. If a list or iterable, then only copy the listed attributes.
- ignorelist, optional
A list of keys for which the contents should not be copied, but only stored by reference.
-
classmethod
from_dict
(dct, validate=True, _wrapper_classes=None)¶ Construct class from a dictionary representation
- Parameters
- dctdictionary
The dict from which to construct the class
- validateboolean
If True (default), then validate the input against the schema.
- _wrapper_classeslist (optional)
The set of SchemaBase classes to use when constructing wrappers of the dict inputs. If not specified, the result of cls._default_wrapper_classes will be used.
- Returns
- objSchema object
The wrapped schema
- Raises
- jsonschema.ValidationError :
if validate=True and dct does not conform to the schema
-
classmethod
from_json
(json_string, validate=True, **kwargs)¶ Instantiate the object from a valid JSON string
- Parameters
- json_stringstring
The string containing a valid JSON chart specification.
- validateboolean
If True (default), then validate the input against the schema.
- **kwargs :
Additional keyword arguments are passed to json.loads
- Returns
- chartChart object
The altair Chart object built from the specification.
-
classmethod
resolve_references
(schema=None)¶ Resolve references in the context of this object’s schema or root schema.
-
to_dict
(self, validate=True, ignore=None, context=None)¶ Return a dictionary representation of the object
- Parameters
- validateboolean or string
If True (default), then validate the output dictionary against the schema. If “deep” then recursively validate all objects in the spec. This takes much more time, but it results in friendlier tracebacks for large objects.
- ignorelist
A list of keys to ignore. This will not passed to child to_dict function calls.
- contextdict (optional)
A context dictionary that will be passed to all child to_dict function calls
- Returns
- dctdictionary
The dictionary representation of this object
- Raises
- jsonschema.ValidationError :
if validate=True and the dict does not conform to the schema
-
to_json
(self, validate=True, ignore=[], context={}, indent=2, sort_keys=True, **kwargs)¶ Emit the JSON representation for this object as a string.
- Parameters
- validateboolean or string
If True (default), then validate the output dictionary against the schema. If “deep” then recursively validate all objects in the spec. This takes much more time, but it results in friendlier tracebacks for large objects.
- ignorelist
A list of keys to ignore. This will not passed to child to_dict function calls.
- contextdict (optional)
A context dictionary that will be passed to all child to_dict function calls
- indentinteger, default 2
the number of spaces of indentation to use
- sort_keysboolean, default True
if True, sort keys in the output
- **kwargs
Additional keyword arguments are passed to
json.dumps()
- Returns
- specstring
The JSON specification of the chart object.
-
classmethod
validate
(instance, schema=None)¶ Validate the instance against the class schema in the context of the rootschema.
-
classmethod
validate_property
(name, value, schema=None)¶ Validate a property against property schema in the context of the rootschema