This article describes how to apply rules to drag-and-drop tables, many R tables*, and visualizations (with tests) in Displayr (not 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). However, the range of available functions extends well beyond formatting. The current library of automated options includes (but is not limited to):
- Blank cells with small sample sizes
- Remove decimals without rounding
- Automatically remove NETs from tables
- Hide non-significant rows or columns
- Sort/reorder rows and columns
*Not all rules are currently compatible with R tables. Incompatible rules will display a warning in the Rules field and in the Rule's pop-up window (if available).
Method - Apply rules
- Select your R table (Calculation).
- To apply a rule, click the Plus (+) button under the Rules section of the Data tab in the object inspector
.
-
The selected rule will then be added to the Rules field box. In this example, we selected two rules, one to blank cells with small counts and the other to move the NET row to the top of the table.
The results are as follows: - 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 by dragging one above the other to ensure they work as intended.
- To automatically apply a rule to all new tables, right-click the rule and tick Use for new tables and charts.
- To add this rule to all existing tables, right-click and select Apply > Add to every item in the document.
- To add this rule to all selected tables, right-click and select Apply > Add to selected items.
- 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
- To edit rules, right-click the appropriate rule in the object inspector
- OPTIONAL: Select Edit JavaScript to customize the underlying code further. Note, Highlight, Top/Bottom, and Color Scales rules cannot be modified in this way.
- Change the necessary settings and press OK.
Method - Delete rules
- To delete rules, right-click the appropriate rule in the object inspector
- Alternatively, you can delete the rule from all existing tables by right-clicking and selecting Apply > Remove from every item in the document.
- To only remove the rule from selected tables, right-click and select Apply > Remove from selected items.
Method - Custom rules
All the rules are written in JavaScript (see Table JavaScript and Plot JavaScript for details). You can write your own rules in JavaScript, applying them by selecting New custom rule (write your own JavaScript). See How to Create a Custom Rule and How to Customize a Rule for more information.