API consistency¶

Generated by python tools/gen_api_consistency.py -- do not edit by hand.

Every public dextra function shares one flag vocabulary. Y = the function accepts the flag; - = the flag does not apply (justified under Documented exceptions).

function	show	plot	return_df	return_fig	return_params	params	df_name	decimals	inplace	protect
`aggfeat`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`anova_oneway`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`audit`	Y	Y	Y	Y	-	-	Y	Y	-	-
`bin`	Y	Y	Y	Y	Y	Y	Y	Y	Y	-
`boxpl`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`cast_types`	Y	Y	Y	Y	-	-	Y	Y	-	-
`chi2ind`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`cim`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`cip`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`class_imbalance`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`classify`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`clip_outliers`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`clus`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`confrep`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`correlation_matrix`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`cross`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`cross_tab`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`dash`	Y	-	-	-	Y	-	Y	-	-	-
`dedup`	Y	Y	Y	Y	-	-	Y	Y	-	-
`describe_numeric`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`dload`	Y	-	-	-	Y	Y	Y	Y	-	-
`dpeek`	Y	-	-	-	-	-	Y	-	-	-
`dtfeats`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`dup_show`	Y	Y	Y	Y	-	-	Y	Y	-	-
`edarep`	Y	-	-	-	Y	-	Y	Y	-	-
`empirical_rule_check`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`encode`	Y	Y	Y	Y	Y	Y	Y	Y	Y	-
`featpipe`	Y	Y	Y	Y	Y	Y	Y	Y	-	Y
`freqtab`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`functions`	-	-	-	-	-	-	-	-	-	-
`gcmp`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`handle_missing`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`hister`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`importance`	Y	Y	Y	Y	Y	Y	Y	Y	-	Y
`learncv`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`missing_report`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`na_show`	Y	Y	Y	Y	-	-	Y	Y	-	-
`normality_test`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`out_show`	Y	Y	Y	Y	-	-	Y	Y	-	-
`outliers_report`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`pearson_skewness`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`redun`	Y	Y	Y	Y	Y	Y	Y	Y	-	Y
`reg`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`relev`	Y	Y	Y	Y	Y	Y	Y	Y	-	Y
`residan`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`rfe`	Y	Y	Y	Y	Y	Y	Y	Y	-	Y
`roc_pr`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`sample_size_mean`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`sample_size_proportion`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`scale`	Y	Y	Y	Y	Y	Y	Y	Y	Y	-
`selectpipe`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`simple_linear_regression`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`standardize_columns`	Y	Y	Y	Y	-	-	Y	Y	-	-
`t1`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`t2`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`t_test_paired`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`transform`	Y	Y	Y	Y	Y	Y	Y	Y	Y	-
`tsdecomp`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`tsfcast`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`tsstat`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`validate_rules`	Y	Y	Y	Y	-	-	Y	Y	-	-
`vif`	Y	Y	Y	Y	Y	Y	Y	Y	-	-
`z_scores`	Y	Y	Y	Y	Y	Y	Y	Y	-	-

Coverage per flag¶

flag	functions carrying it
`show`	62/63
`plot`	58/63
`return_df`	58/63
`return_fig`	58/63
`return_params`	53/63
`params`	51/63
`df_name`	62/63
`decimals`	60/63
`inplace`	4/63
`protect`	5/63

Documented exceptions¶

Without show / df_name: functions -- zero-argument discoverability helpers (nothing to report on).
inplace exists only on the four column-writing transforms (transform, scale, bin, encode); inside featpipe it defaults to True (0.6.0).
protect exists on the selectors (relevance, redundancy) and featpipe, where auto-selection could otherwise swallow a target.
Every function accepting params also accepts return_params (fit/apply symmetry holds with zero exceptions).