Study Overview Page
Studies are the core organizational unit in the application. All data preparation, analysis tasks, and reporting are performed within the context of a study. The study overview page provides a summary of all the information related to a single study.
There are three main sections available on the study overview page, each of which will be discussed in the following sections:
- Datasets
- Tasks
- Reports
Each section depends on the previous, so a task cannot exist without a dataset, and a report cannot exist without at least one task. Hence the workflow within a study is always to create a dataset, then use it in a task, and finally create a report based on the results of the task.
Datasets
To create a new dataset click on the Upload Dataset
button at the top of this page. A modal will appear where you can upload a file from your local system or select an example dataset provided by the application.
Datasets can also be derived from other datasets. This is done by selecting the Transform
action that appears when hovering over the dataset timestamp. This will open the Data Wrangling modal where you can apply various transformations to the dataset to generate a derived dataset.
Other actions that appear when hovering over a dataset are:
Copy
: create a copy of the dataset.View
: view the dataset in a separate browser tab.Download
: download the dataset as.csv
,.arrow
, or.xpt
format.Edit
: edit the upload settings or applied transformations, as well as dataset name.Remove
: delete the dataset. This action is only available if the dataset is not used in any tasks.
For further details see the Data Upload section of the documentation.
Tasks
Once at least one dataset is available in the study, you can create a task by clicking on the Run New Task
button at the top of the page. This will navigate to the task creation page where you can select the dataset to use and then configure the task settings.
Actions that appear when hovering over a task are:
Copy
: create a copy of the task.Edit
: edit the task name and authors.Remove
: delete the task. This action is only available if the task has not been used in any reports.
Refer to the Tasks
section of the documentation for further details on how to configure analysis tasks.
Reports
After at least one task has been created, you will be able to generate reports based on the analysis results of those tasks. To do this click on the Generate Report
button at the top of the page. This will open the report creation modal where you can select the tasks to use as the basis for the report.
Actions that appear when hovering over a report are:
Download
: download the report as a.pdf
or.docx
file.Edit
: edit the report via theEdit Report
modal.Remove
: delete the report.
For further details see the Report Generation section of the documentation.