When creating a report, you may want to organize content into different sections or groups. You can group similar pages together in a folder to be able to hide and expand the list of pages as needed when navigating the document.
This article describes the various ways of creating folders in the Report tree. In this example, Missing Value and Scatterplot analyses are stored in a folder called Data Examination, and Linear Regression and Stepwise Regression models are grouped into a folder called Regression Models. The pages labeled Cook's Distance and Heteroscedasticity are not stored in folders.
Requirements
- Some options require the use of QScript. To use this, you will need a Displayr Enterprise user license which includes the ability to add custom analysis menu items.
Method
A folder in the report is essentially a page, similar to a section slide in PowerPoint. This means users can click on a folder and be taken to a page in your published dashboard, and that a folder will be exported as a slide to PowerPoint. This means you can also format a folder page as any other page in your document, adding text, tables, and other outputs as needed. Given this, folders can be made in a few different ways:
1. Dragging a page onto another page
In the Report tree, you can drag any Page(s) on top of a Page to convert the Page into a Folder page and have the selected Pages nested underneath.
2. Clicking the + icon while hovering over an existing page/folder
3. Right-clicking in any blank area of the report tree
4. Using QScript Functions
See How to Create a Custom QScript for more information on writing QScripts. A specific function - project.report.appendFolder() can be applied to add folders to the Report tree.