tally.build.Options#

class tally.build.Options(table_options=None, formats=None, parent=None)#

Options for both sheet and build with convenience methods to change both data and visuals.

__init__(table_options=None, formats=None, parent=None)#

Methods

__init__([table_options, formats, parent])

freeze_panes([row, column])

Set where to freeze panes in the Excel file.

merge(options)

Merge two Option objects together, this one overriding the incoming one

merge_dict(source, destination)

Merge two dictionaries by having the destination override the source, recursively.

set_annotations(annotations)

Set whether tables are annotated with information about sig-testing, weight applied, and base.

set_answer_format(answer_type, format)

Set the format for an answer, e.g.

set_banner_border(border)

Set whether there should be a border between the banner categories, like gender and age.

set_base_labels(label[, unweighted_label])

Set the labels for the base and unweighted base.

set_base_position(position)

Change the position of the base

set_ci(ci)

Set what the table cells should contain

set_column_format_for_type(answer_type, ...)

Set column format for answer type.

set_filter(filter)

Set filter to use on all data

set_font(name[, size])

Sets the global font name and size to be used in Excel.

set_format(name, new_format)

Set format for a question type in the table

set_hide_gridlines(hide)

Show or hide gridlines in the spreadsheet.

set_language_key(text_key)

Set language key for results.

set_question_format(answer_type, format)

Set the format rules for the question (line at the top of every table showing variable label)

set_row_colors(colors)

Set alternating row colors of the Excel spreadsheet :param colors: list of colours that will be alternated across (supply two colours to get stripes) :type colors: list

set_show_bases(bases)

Set what bases should be shown in the table.

set_show_table_base_column(xtotal)

Show column on the far left with the totals from all of the data.

set_sig_test_levels(sig_test_level)

Set alpha level for sig-testing.

set_stats([stats])

Decide on what statistics to show

set_stub(default_stub)

Set what variables should be in the stub.

set_top_offset(offset_row)

Set where the data starts in the Excel sheet.

set_top_offset_after_header(offset_row)

Set how many empty lines are below the header.

set_weight(weight)

Set the variable used to weight.