Skip to content

DataFrame Summary Options

Bases: SeriesSummaryOpts


              flowchart TD
              metaframe.src.utils.opts_dataclass.summary.DataFrameSummaryOpts[DataFrameSummaryOpts]
              metaframe.src.utils.opts_dataclass.summary.SeriesSummaryOpts[SeriesSummaryOpts]

                              metaframe.src.utils.opts_dataclass.summary.SeriesSummaryOpts --> metaframe.src.utils.opts_dataclass.summary.DataFrameSummaryOpts
                


              click metaframe.src.utils.opts_dataclass.summary.DataFrameSummaryOpts href "" "metaframe.src.utils.opts_dataclass.summary.DataFrameSummaryOpts"
              click metaframe.src.utils.opts_dataclass.summary.SeriesSummaryOpts href "" "metaframe.src.utils.opts_dataclass.summary.SeriesSummaryOpts"

DataFrame-specific summary parameters.

Extends SeriesSummaryOpts with DataFrame-specific parameters.

Parameters:

Name Type Description Default
axis Literal[0, 1]

On which axis to apply the summary.

 0
label_self str | None

Name to give to self. If None, 'Table' for table DataFrame, 'DataFrame' else

 None
label_n_row str

Label for columns containing row information

 'Rows'
label_n_col str

Label for columns containing columns information

 'Columns'
label_n_cells str

Label for columns containing cell information

 'Cells'
label_mfr str

Label for rows containing MetaFrameRow information

 'MFR'
label_mfc str

Label for rows containing MetaFrameCol information

 'MFC'
by Any

pandas.DataFrame.groupby by parameter

 None
dropna bool

pandas.DataFrame.groupby dropna parameter

 True
Source code in metaframe/src/utils/opts_dataclass/summary.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
@dataclass(frozen=True, kw_only=True, slots=True)
class DataFrameSummaryOpts(SeriesSummaryOpts):
    """
    DataFrame-specific `summary` parameters.

    Extends `SeriesSummaryOpts` with DataFrame-specific
    parameters.

    Parameters
    ----------
    axis: Literal[0, 1] = 0
        On which axis to apply the summary.
    label_self: str | None = None
        Name to give to self.
        If None, 'Table' for table DataFrame, 'DataFrame' else 
    label_n_row: str = "Rows"
        Label for columns containing row information
    label_n_col: str = "Columns"
        Label for columns containing columns information
    label_n_cells: str = "Cells"
        Label for columns containing cell information
    label_mfr: str = "MFR"
        Label for rows containing MetaFrameRow information
    label_mfc: str = "MFC"
        Label for rows containing MetaFrameCol information
    by: Any
        pandas.DataFrame.groupby by parameter
    dropna: bool
        pandas.DataFrame.groupby dropna parameter
    """
    ## DataFrame.summary() opts
    axis: Literal[0, 1] = 0
    label_self: str | None = None
    label_n_row: str = "Rows"
    label_n_col: str = "Columns"
    label_n_cells: str = "Cells"
    label_mfr: str = "MFR"
    label_mfc: str = "MFC"
    ## Group-by parameters
    by: Any = None
    dropna: bool = True
    ## Other kwargs from Series summary are possible

    def __post_init__(self):
        check_is(self.axis, is_axis)
    def get_series_summary_opts(self):
        return {f.name: getattr(self, f.name) for f in fields(SeriesSummaryOpts)}