The footer (known as Caption in Displayr) shown below a table or chart can be customized in various ways, including:
- Via the menu, this will be in the object inspector under Appearance > Caption. Options > Edit > Caption Options are further explained below.
- Using Rules on built-in tables and visualizations.
- Manually editing and formatting the caption by directly clicking into the text.
- Modifying the text programmatically using R, if the table or visualization is R-based, see this article.
Caption Options
The Caption Options governs with information about the table, such as filters and weights, is displayed in the caption. A preview is shown at the bottom of the dialog box. Anything shown in the triangular brackets is calculated for each table. For example, in sample size = <n>, <n> is replaced by the sample size when the table is exported or printed. You can edit the various components of the footer. For example, we could replace sample size = <n> with Sample Size is <n> people.
When editing footers it is important to remember that:
- Apply to Selection - will apply only to tables that are selected. This means that if you click on a single table and make changes, these changes will not be applied to all the other tables in the project.
- Set as Default - will change all the tables using the default caption (which haven't already been modified).
- If you remove the triangular brackets nothing is calculated and your footer may be incorrect. For example, you replaced effective sample size = <ess> (<ess%>) with ESS is 923, this would be incorrect if you applied a different filter or weight to the table.
Custom text Enter any text. This will always be inserted at the start of the footer. To insert a new line in this or any other field in the footer, hold down Alt on your keyboard and type 0182.
Delimiter This character will seperate each of the footer items.
Include Check the include option in each section of this dialog box to select a specific type of content to appear in the footer.
Variable set name
When summary <blue> will be replaced with the name of the question in the blue dropdown.<brown> will be replaced with "SUMMARY" or "RAW DATA"; you may remove <brown> from the text to stop it appearing.
When crosstab <blue> will be replaced with the name of the question in the blue dropdown.
<brown> will be replaced with the name of the question in the brown dropdown.
Date
Use today's date Today's date will be used to replace the <date> token in the Text field. The format used to display the date comes from your Windows regional settings. When you print or export the table, this date will appear as the date of printing or exporting.
Use Date variable Instead of using today's date, select a variable which has a Question Type of Date from your data file. It's date period will be used intelligently when displaying the date; for example, if your date period is months, "January 2011" will be shown.
Text <date> will be replaced with either today's date or the last date from the data of the Date variable.
Filter
Filter present <filter> will be replaced by the name(s) of the selected filter variables.
When no filter This text will be copied verbatim when there are no filter variables selected for the table.
Weight
Weight present <weight> will be replaced by the name(s) of the selected weighting variable.
When no weight This text will be copied verbatim when there are is no weighting variable selected for the table.
Count
<n> will be replaced by a description of the Sample Size statistic for all cells in the table (if they vary, this will show a range).
Total n
<totalN> will be replaced by the number of respondents that were in the filter (or if no filter, the total sample).
Missing
<missing> will be replaced by the number of respondents missing from the lowest Sample Size of the table.
Effective sample size
<ess> will be replaced by the Effective sample size for all cells in the table.<ess%> will be replaced by Effective sample size / Sample Size.
% filtered out
<out%> will be replaced by the percentage of respondents not in the filter. If there is no filter, nothing will be shown.
Significance testing
Include when significance shown If significance is not being shown on a table (see Table Styles) then this output will not appear in the footer irrespective of whether or not it is checked.
Text When Include when significance shown is ticked this text will be included in the footer and <test> will be replaced by the Cell multiple comparison correction and <p> will be replaced by the Overall significance level from the Advanced Statistical Testing Assumptions.
Minimal sample size for testing
Include when significance shown If checked, when significance is shown on the table or chart, this text will be included in the footer and <min> will be replaced by the Minimal sample size for testing number from the Statistical Assumptions. If significance is not being shown on a table then this output will not appear in the footer irrespective of whether or not it is checked.
Date significance
If the table/chart contains a date question, this text will be included in the footer and <dateComparison> will be replaced by the selected value of Date questions: from Advanced Statistical Testing Assumptions.
Column multiple comparison correction
Include when columns compared If Column Comparisons have not being shown on a table then this output will not appear in the footer irrespective of whether or not it is checked.
Text When the Column comparisons statistic is shown on the table and the Cell multiple comparison correction differs from the Column comparisons multiple comparison correction, this text will be included in the footer and <test> will be replaced by the Column comparisons multiple comparison correction from the Advanced Statistical Testing Assumptions.
Column comparison legend
Include when columns compared If Column Comparisons have not being shown on a table then this output will not appear in the footer irrespective of whether or not it is checked.
Text When the Column comparisons statistic is shown on the table, this text will be included in the footer and <lettersList> will be replaced by the distinct sets of Column letters from the Advanced Statistical Testing Assumptions that apply for the Overall significance level. For example, "a, b, c... (p = 0.05), A, B, C... (p = 0.001)". If you prefer to use your own formatting, you may use <pXX> where XX is one of the Cutoff p-values from the Advanced Statistical Testing Assumptions, for example, the text "Column comparison symbols: <p0.05> (p = 95%), <p0.001> (p = 99.9%)" will produce "Column comparison symbols: a, b, c... (p = 95%), A, B, C... (p = 99.9%)".
Truncate after N letters When this is ticked, the set of Column letters in the Text will be truncated after N letters (by default, 3 letters). If this is not ticked, all of the Column letters will be shown in the footer.
No column test symbol
Include when columns compared If Column Comparisons have not being shown on a table then this output will not appear in the footer irrespective of whether or not it is checked.
Text When the Column comparisons statistic is shown on the table, this text will be included in the footer and <noTest> will be replaced by the No test symbol from the Advanced Statistical Testing Assumptions. Non-significant column test symbol Include when columns compared
Text When the Column comparisons statistic is shown on the table, this text will be included in the footer and <notSig> will be replaced by the Symbol for non-significant test from the Advanced Statistical Testing Assumptions.
Captions can be modified using Rules. You can find these under the object inspector > Data > Rules > + > Caption menu, see our section on customizing footers in the Displayr Help center, or you write a custom rule using table.extraFooters.
Next
Displayr: How to Show Hide Edit Captions for Tables and Charts