Modify Footers - Add Column Header Footnote Indicating Small Sample Sizes

From Q
Jump to navigation Jump to search


This rule adds an asterisk to the column header and adds a footnote whenever a Column n is less than a user-specified amount (default is 30).

Example

SmallSampleSizeHeaderAndFooterRule.png

How to apply this rule

For the first time in a project

  • Select the table(s)/chart(s) that you wish to apply the rule to.
  • Start typing the name of the Rule into the Search features and data box in the top right of the Q window.
  • Click on the Rule when it appears in the QScripts and Rules section of the search results.

OR

  • Select Automate > Browse Online Library.
  • Choose this rule from the list.

Additional applications of the rule

  • Select a table or chart that has the rule and any table(s)/chart(s) that you wish to apply the rule to.
  • Click on the Rules tab (bottom-left of the table/chart).
  • Select the rule that you wish to apply.
  • Click on the Apply drop-down and choose your desired option.
  • Check New items to have it automatically applied to new items that you create. Use Edit > Project Options > Save as Template to create a new project template that automatically uses this rule.

Removing the rule

  • Select the table(s)/chart(s) that you wish to remove the rule from.
  • Press the Rules tab (bottom-right corner).
  • Press Apply next to the rule you wish to remove and choose the appropriate option.

How to modify the rule

  • Click on the Rules tab (bottom-left of the table/chart).
  • Select the rule that you wish to modify.
  • Click Edit Rule and make the desired changes. Alternatively, you can use the JavaScript below to make your own rule (see Customizing Rules).

JavaScript

includeWeb('Table JavaScript Utility Functions'); 

excludeRTables();

let stat_name = table.getTranslation('Column n');
if (table.availableStatistics.indexOf('Column n') == -1)
    form.ruleNotApplicable('this format only applies to tables with the ' + stat_name + ' statistic');

// Set up controls for user input.
form.setHeading('Add Column Header Footnote Indicating Small Sample Sizes');
let label = form.newLabel('Minimum ' + stat_name + ':');
let numeric_up_down  = form.newNumericUpDown('threshold');
numeric_up_down.setDefault(30);
numeric_up_down.setIncrement(1);
numeric_up_down.setMaximum(999999999);
let description = form.newLabel('Adds an asterisk to the column header and adds a footnote whenever the ' +
                                stat_name + ' is less than a user-specified amount.');
description.lineBreakAfter = true;
form.setInputControls([description, label, numeric_up_down]);
let min_column_n = numeric_up_down.requireValue();
form.setSummary('Add a column header footnote when ' + stat_name + ' < ' + min_column_n);

let footnote_flag = false;
let column_ns = table.get('Column n');// Get the Column N statistics.
let column_labels = table.columnLabels;// Get the column labels.
for (let column = 0; column < table.numberColumns; column++) {// For each column...
    let column_n = column_ns[0][column];// Get the column n statistic (from the cell in the first row).
    if (column_n < min_column_n) {
        column_labels[column] += '*';// Put a marker on this column's label.
        footnote_flag = true;
    }
}
if (footnote_flag) {
    table.columnLabels = column_labels;// Store the adjusted column labels and footnotes.
    let footnotes = table.extraFooters;// Make a list of extra footnotes.
    footnotes.push('*column has less than ' + min_column_n + ' respondents.');// Add an extra footnote.
    table.extraFooters = footnotes;
}

See also

Retrieved from ‘https://wiki.q-researchsoftware.com/index.php?title=Modify_Footers_-_Add_Column_Header_Footnote_Indicating_Small_Sample_Sizes&oldid=64278’