-
Notifications
You must be signed in to change notification settings - Fork 10
Quickstart Tutorial For Windows
Before beginning this tutorial, please install DeepPhe for Windows.
This tutorial will take you through the following steps:
- Starting the DeepPhe Database
- Starting the DeepPhe GUI
- Configuring the DeepPhe GUI to process the provided example fictitious patient reports
- Processing the fictitious patient reports and saving the results to the DeepPhe Database, and to various output files
- Viewing the results in the DeepPhe Visualizer
The first thing we will need to do is start the DeepPhe database so the DeepPhe GUI has a place to store results, and those results can be viewed in the DeepPhe Visualizer.
DeepPhe uses a Neo4j Database to store results. To start the DeepPhe database, go to your DeepPhe installation directory ("DeepPhe" in your Applications folder by default), and click the start-neo4j.command.
Once the DeepPhe Database is running you will see a terminal that looks as follows.
Those familiar with databases can monitor this window for debug messages written by DeepPhe. Most users can happily ignore this window, but it must remain open while using DeepPhe or the DeepPhe-Visualizer.
Now that the database is running, we are ready to start the DeepPhe GUI.
Open your Start Menu and click on the DeepPheGUI shortcut.
Welcome to the DeepPhe GUI
Before we run, we first need to configure the GUI to process the example patient reports. Set the parameters as follows:
-
InputDirectory:
/Users/yourHomeDirectory/DeepPheDocs -
OutputDirectory:
/Users/yourHomeDirectory/DeepPheDocsOutput (directory must exist on filesystem) -
StartNeo4j:
(leave blank) -
StopNeo4j:
(leave blank) -
Neo4jUri:
bolt://127.0.0.1:7687 -
Neo4jUser:
neo4j -
Neo4jPass:
neo4jpass
We are all set and ready to run. To run DeepPhe, click the green button at the top of the screen that looks like a person on a run.
DeepPhe will run and display a "COMPLETE" message when it's finished.
Depending on the version of DeepPhe you are running, DeepPhe will either close automatically or ask you to press a button to close DeepPhe. If the DeepPhe software didn't close automatically, you can close it now.
With the patient reports processed by DeepPhe, we can now view the results written to the database in the DeepPhe Visualizer.
Open your start menu and then click the Start Visualizer shortcut:
This script will start Node.js, install some required packages...
The DeepPhe Visualizer will automatically open in a browser window.
Coming soon.
Open the Pages section (above) to view all pages by title.
Installation
Windows
Mac
Linux
Known Issues
Quickstart
Windows Quickstart Tutorial
Mac Quickstart Tutorial
Using DeepPhe-XN With Your Own Files
Input File Requirements
Configuring DeepPhe Phenotype Summarizer
Example Files Description
Using DeepPhe-XN Visualizer
Additional Output File Types
Example File Data Specifics
About the DeepPhe Pipeline
Pipeline Description
Code Modules
-
AE
-
division
-
section
-
temporal
-
CR
-
filetree
-
naaccr