The validate API

validate API Reference

probscale.validate.axes_object(ax)

Checks if a value if an Axes. If None, a new one is created. Both the figure and axes are returned (in that order).

probscale.validate.axis_name(axis, axname)

Checks that an axis name is in {'x', 'y'}. Raises an error on an invalid value. Returns the lower case verion of valid values.

probscale.validate.fit_argument(arg, argname)

Checks that an axis options is in {'x', y', 'both', None}. Raises an error on an invalid value. Returns the lower case verion of valid values.

probscale.validate.axis_type(axtype)

Checks that a valid axis type is requested.

• pp - percentile axis
• qq - quantile axis
• prob - probability axis

Raises an error on an invalid value. Returns the lower case verion of valid values.

probscale.validate.axis_label(label)

Replaces None with an empty string for axis labels.

probscale.validate.other_options(options)

Replaces None with an empty dict for plotting options.

probscale.validate.estimator(value)