How to Use Rules in Displayr

This article describes how to apply rules to default tables and charts (with tests) in Displayr (i.e. not R tables or R-based visualizations). Rules are a set of predefined automated functions – most commonly they could be thought of as a way of conditionally formatting tables (where you specify the conditions). But the range of available functions extends well beyond formatting. The current library of automated options includes (but is not limited to):

• Highlighting cells or chart series via custom criteria (e.g., ranges, greater/less than, top n).
• Applying color scales to entire tables or charts.
• Adding text, symbols to table cells or chart data labels.
• Customizing significance comparisons.
• Removing rows or columns or hiding cells based in specific criteria (e.g., minimum sample size).
• Reformatting columns (e.g., include sample size; re-label but leave source variable intact).
• Customizing footers.
• Automatically re-sorting charts or tables, by columns or rows of your choice.
• Weighting selected columns or rows.

Requirements

A Displayr document with tables.

Method - Apply Rules

1. To apply a rule, simply select your table and click the Plus (+) button under the RULES section of the Properties tab in the object inspector.
2. The selected rule will then be added to the RULES field box.
3. You are able to add multiple rules to your table. Note, the rules will be applied in the order they appear in this box. Depending on the rules being used, you may need to change the order via dragging one above the other to ensure they work as intended. For example, if you wish to shade table cells but also want to remove values under a specific value, you would need to apply the shading cells rule first.
4. To automatically apply this rule to all new tables, right-click the rule and tick Use for new table and charts.
5. To add this rule to all existing tables, right-click and select Apply > Add to every item in the document.
6. To add this rule to all selected tables, right-click and select Apply > Add to selected items.
7. Note that changing the dimensions of a table by, for example, using the Switch rows and columns option, will affect the implementation of the rule. You may then need to apply an alternate rule if it is specific to rows or columns.

Method - Edit Rules

1. To edit rules, right-click the appropriate rule in the object inspector and select Edit.
2. OPTIONAL: Select Edit JavaScript to customize the underlying code further. Note, Highlight Cells, Top/Bottom and Color Scale Rules cannot be modified in this way.
3. Change the necessary settings and press OK.

Method - Delete Rules

1. To delete rules, right-click the appropriate rule in the object inspector > Delete. Note, if you have applied this rule to all tables in one step (as opposed to doing so individually) or have copied a table with the rule already applied, this option will delete it from all tables that use this rule. You can highlight which tables are connected by this rule by selecting the Show all tables using this rule option.

2. Alternatively, you can delete the rule from all existing tables by right-clicking and selecting Apply > Remove from every item in the document.
3. To only remove the rule from selected tables, right-click and select Apply > Remove from selected items.

Next

How Rules Work in Displayr

How to Customize a Rule

How to Create a Custom Rule