Skip to content

documentation.md

Latest commit

 

History

History
81 lines (73 loc) · 4.23 KB

documentation.md

File metadata and controls

81 lines (73 loc) · 4.23 KB
Raw
title Documentation
permalink /documentation/
layout default
bodyClass page-documentation
description DeepPhe documentation guides for installation, desktop use, visualization, API access, and database pipeline workflows.

Guides and references

Documentation

Start with installation, then use these guides to run DeepPhe, load and access its data, and explore the results.

DeepPhe documentation guides

01 · Start here

DeepPhe Installation Guide

Download the installer and get started with DeepPhe Translational and DeepPhe Visualizer.

Open guide → 
  <a class="documentation-card" href="https://deepphe.github.io/dphe-gui/">
    <div class="documentation-card-top">
      <span class="documentation-card-icon" aria-hidden="true"><i class="fas fa-desktop"></i></span>
      <span class="documentation-card-step">02 · Run</span>
    </div>
    <h2>DeepPhe Desktop GUI Guide</h2>
    <p>Run DeepPhe and manage processing from the desktop application.</p>
    <span class="documentation-card-action">Open guide <span aria-hidden="true">&rarr;</span></span>
  </a>

  <a class="documentation-card" href="https://deepphe.github.io/dphe-db-pipeline/">
    <div class="documentation-card-top">
      <span class="documentation-card-icon" aria-hidden="true"><i class="fas fa-database"></i></span>
      <span class="documentation-card-step">03 · Store</span>
    </div>
    <h2>DeepPhe DB Pipeline</h2>
    <p>Load DeepPhe output into the database used by DeepPhe Data API and DeepPhe Visualizer.</p>
    <span class="documentation-card-action">Open guide <span aria-hidden="true">&rarr;</span></span>
  </a>

  <a class="documentation-card" href="https://deepphe.github.io/dphe-data-api/">
    <div class="documentation-card-top">
      <span class="documentation-card-icon" aria-hidden="true"><i class="fas fa-code"></i></span>
      <span class="documentation-card-step">04 · Access</span>
    </div>
    <h2>DeepPhe Data API</h2>
    <p>Query DeepPhe data programmatically and connect it to downstream applications.</p>
    <span class="documentation-card-action">Open guide <span aria-hidden="true">&rarr;</span></span>
  </a>

  <a class="documentation-card" href="https://deepphe.github.io/DeepPhe-Visualizer-v2/">
    <div class="documentation-card-top">
      <span class="documentation-card-icon" aria-hidden="true"><i class="fas fa-chart-line"></i></span>
      <span class="documentation-card-step">05 · Explore</span>
    </div>
    <h2>DeepPhe Visualizer 2 User Guide</h2>
    <p>Install and use version 2 of the web application to explore cohorts and individual patient records.</p>
    <span class="documentation-card-action">Open guide <span aria-hidden="true">&rarr;</span></span>
  </a>

  <a class="documentation-card" href="https://github.com/DeepPhe/DeepPhe-Release/wiki">
    <div class="documentation-card-top">
      <span class="documentation-card-icon" aria-hidden="true"><i class="fas fa-gears"></i></span>
      <span class="documentation-card-step">NLP Configuration</span>
    </div>
    <h2>DeepPhe Patient Summarizer Wiki</h2>
    <p>Information on the NLP Patient Summarizer, input, output and processing.</p>
    <span class="documentation-card-action">Open wiki <span aria-hidden="true">&rarr;</span></span>
  </a>

</div>