Related analysis and reporting are stored in Displayr documents. The first step in conducting any analysis is to create a document.
A Displayr document contains:
- Your raw data.
- All the analyses you have done.
- Reporting.
- Instructions for automatically updating the analyses and reporting.
Documents page
The documents page lists all your Displayr documents, as well as any folders that you have created. Displayr documents can be created in a number of ways:
- You can manually create them by clicking + New Document.
- They can be automatically created when you click on various links (e.g., online tutorials).
- You can upload QPack files to create them, by clicking Upload > QPack, see How to Create a Displayr Document Using a QPack.
You can have Free documents, which do not require a license but have limited capabilities, or you can have Professional documents, which require a paid license to edit and View Hours to publish, see Free vs Professional Documents for more details.
Edit mode
Once you have created a document, you go into edit mode, which is where you perform your analyses and design your reports. The image below lists the key features of the user interface.
Time spent in Edit Mode in a Professional document will count towards your editing hour allotment that comes with your individual license, see the FAQ at the bottom of our pricing page.
Document settings
Document settings can be accessed by clicking on the Tools Menu and then Document Settings (see below).
View mode
View mode is how Displayr appears to end-users. That is, it is what people see when they view a document that has been published as a web page.
You can purchase View hours which will enable you to publish a Professional document as an online dashboard and share with others, see the FAQ at the bottom of our pricing page.
Account settings
Settings for the account (e.g., invoicing, users) are obtained by clicking on the initials icon in the upper right corner of the screen (see below) and selecting Account Settings.
Displayr Cloud Drive
The Displayr Cloud Drive is an online file storage system built into your Displayr account. You can import and export data to the cloud from your documents as well as host image files and other files used in your Documents. You can also create a shareable link for others to access these files directly. The Displayr Cloud Drive can be accessed by clicking on the initials icon in the upper right corner and selecting Displayr Cloud Drive.
Programmatic control of Displayr
In addition to having a graphical user interface, Displayr has various tools for performing analysis and reporting via code:
- Displayr allows you to write R code from within the app. Additional languages can be run from within the R code, including C++, Python, and HTML.
- QScript is our scripting language for "driving" the user interface from within Displayr (e.g., creating new tables, cleaning data, etc.). This is a version of JavaScript.
- The Displayr API allows Displayr documents to be created and modified by code.