2 How to Start
This step-by-step guide will help users get started with the application, including navigation through the interface.
In the initial version of analycyte
, there are no user accounts or login features. These features may be developed in future updates.
2.0.1 Dashboard Page
The main application page is located under the Dashboard tab.
-
Select a folder button: Users can select the base of an
analycyte-projects
session by choosing Select folder.If a project folder exists, it will be opened.
If there is no existing project folder, the user will be prompted to fill out a form about the project.
Users can choose a project description and the name of a sub-folder. If no ‘folder name’ is specified, the project folder will increment with a name like ‘p000X’.
- Toolbox Navigation: Users can navigate through the application using the toolbox.
2.0.2 The Application left panel
Once an analycyte-projects
session is launched:
Choose a Project | Folder of reference for the analysis. |
Cell Set |
<hash> folder with cell set containing the .rds object of cells. |
Feature Set |
<hash> folder with feature set containing the .rds object of features. |
Dashboard | Main interface area. |
Dataset Tab | Displays the current dataset infos. |
Export Project | Allows retrieval of the specified folder through ‘Choose a Project’. |
Expert View | A dropdown menu that includes various advanced options: |
User Actions | Logs user actions with options to annotate(tbd) or delete steps. Deleting a step with dependencies will automatically delete those dependencies. |
Project List | Lists all projects on the same machine, with options to annotate or delete projects. Deleting a project will erase the folder and its subfolders. |
Users Info | Contains tables for authors and affiliations (tbd). |
Available Modules | Lists all actions available to the user. |
Session Information Tab | Displays the current version of the tool and the global variables in use. |
Closing Session | Sessions can be closed using the Close Session button. |
Deleting Session | A session and all its contained project folders can be deleted by clicking Delete Session ; a confirmation message will be displayed. |