Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
fix formatting
  • Loading branch information
gtollefson authored Jul 27, 2020
1 parent 9da596b commit d3109b7
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ Simply download [Proteinarium.zip](https://drive.google.com/file/d/14Lz1EVj1qY9N

## Requirements
At least one of Java 1.8, Java 9, or Java 10 must be installed in order to run Proteinarium. The Proteinarium GUI, in addition to Java, requires JavaFX to be installed. Java 1.8 comes with JavaFX as part of the JDK and JRE.

----------------------------------------------

## Video Tutorials
We've recorded two video tutorials that show how to download and run Proteinarium using the command line and graphical user interfaces. Click the video thumbnails below to watch them.

Expand Down Expand Up @@ -43,7 +45,6 @@ group2GeneSetFile = group2.txt
projectName = Project Name Here
```


## 2. Running Proteinarium
The `<arguments>` is `config=config.txt`

Expand Down Expand Up @@ -114,6 +115,7 @@ To view the summary information for a particular cluster or sample, enter "info
**Note**: the above information is available for all patients at any time in the **\<projectName\>_ClusterAnalyses.csv** output file.

----------------------------------------------

## Running Proteinarium with Graphical User Interface (GUI)

## 1. Getting Started
Expand Down Expand Up @@ -147,7 +149,6 @@ To view the summary information for a particular cluster or sample, enter "info
* **\<projectName>\_Dendrogram.png:** dendrogram image
* **\<projectName>\_Dendrogram.txt:** representation of the dendrogram in Newick tree format


## 3. Viewing Clusters

* When Proteinarium is done running, the GUI will navigate to a new window in which you can input the Cluster/Sample ID for which you are interesting in viewing or obtaining more information.
Expand Down

0 comments on commit d3109b7

Please sign in to comment.