View¶
-
class
quantipy.
View
(link=None, name=None, kwargs=None)¶ -
get_edit_params
()¶ Provides the View’s Link edit kwargs with fallbacks to default values.
Returns: edit_params – A tuple of kwargs controlling the following supported Link data edits: logic, calc, … Return type: tuple
-
get_std_params
()¶ Provides the View’s standard kwargs with fallbacks to default values.
Returns: std_parameters – A tuple of the common kwargs controlling the general View method behaviour: axis, relation, rel_to, weights, text Return type: tuple
-
has_other_source
()¶ Tests if the View is generated with a swapped x-axis.
-
is_base
()¶ Tests if the View is a base size aggregation.
-
is_counts
()¶ Tests if the View is a count representation of a frequency.
-
is_cumulative
()¶ Tests if the View is a cumulative frequency.
-
is_meanstest
()¶ Tests if the View is a statistical test of differences in means.
-
is_net
()¶ Tests if the View is a code group/net aggregation.
-
is_pct
()¶ Tests if the View is a percentage representation of a frequency.
-
is_propstest
()¶ Tests if the View is a statistical test of differences in proportions.
-
is_stat
()¶ Tests if the View is a sample statistic.
-
is_sum
()¶ Tests if the View is a plain sum aggregation.
-
is_weighted
()¶ Tests if the View is performed on weighted data.
-
meta
()¶ Get a summary on a View’s meta information.
Returns: viewmeta – A dictionary that contains global aggregation information. Return type: dict
-
missing
()¶ Returns any excluded value codes.
-
nests
()¶ Slice a nested
View.dataframe
into its innermost column sections.
-
notation
(method, condition)¶ Generate the View’s Stack key notation string.
Parameters: shortname, relation (aggname,) – Strings for the aggregation name, the method’s shortname and the relation component of the View notation. Returns: notation – The View notation. Return type: str
-
rescaling
()¶ Returns the rescaling specification of value codes.
-
spec_condition
(link, conditionals=None, expand=None)¶ Updates the View notation’s condition component based on agg. details.
Parameters: link (Link) – Returns: relation_string – The relation part of the View name notation. Return type: str
-
weights
()¶ Returns the weight variable name used in the aggregation.
-