Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jschust authored Jul 1, 2020
1 parent b8d96f6 commit 8215a73
Showing 1 changed file with 2 additions and 9 deletions.
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,7 @@ To view the summary information for a particular cluster or sample, enter "info

### Running Proteinarium
* Once files are uploaded and parameters are set, click “Run Proteinarium”

* If more than one sample is contained within the input file (s), the dendrogam will be displayed. All output files generated by Proteinarium will be saved to the folder specified by the outputDirectory configuration option. By default, this goes to a folder called “Output” in the same directory as the Proteinarium.jar file.

* **\<projectName>\_ClusterAnalyses.csv:** cluster analysis files
* **\<projectName>\_Dendrogram.png:** dendrogram image
* **\<projectName>\_Dendrogram.txt:** representation of the dendrogram in Newick tree format
Expand All @@ -126,18 +124,14 @@ To view the summary information for a particular cluster or sample, enter "info
## 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.

* Enter sample ID or branch number (ex: C12) in the space provided.

* Select either “View Cluster” or “Get Cluster Information”.

* If “View Cluster” is selected, the corresponding the output files will be available in the \<outputDirectory\>/<cluster or sample ID\> folder. And the following files are generated:
* **\<cluster or sample ID>\_Dendrogram.txt**
* For each of the five possible output networks--Group 1, Group 2, [Group 1 + Group 2], [Group 1 - Group 2], [Group 2 - Group 1], three files are generated to summarize that network. For example:
* **\<cluster or sample ID>\_Dendrogram.txt**
* For each of the five possible output networks--Group 1, Group 2, [Group 1 + Group 2], [Group 1 - Group 2], [Group 2 - Group 1], three files are generated to summarize that network. For example:
1. **\<cluster or sample ID>\_Group1_GeneSet.txt:** list of genes in the network and information about which input set they originated from (i.e. from Group 1, Group 2, or imputed from the interactome) and on how many samples the gene was found
2. **\<cluster or sample ID>\_Group1_Interactions.txt:** network interaction matrix
3. **\<cluster or sample ID>\_Group1.png:** image of the network

* If “Get Cluster Information” is selected, the following information will be appended to the file “SystemsOutput.txt” as indicated by the text box of the GUI.
* *Average Distance (Height)*
* *Bootstrapping Confidence*
Expand All @@ -152,7 +146,6 @@ To view the summary information for a particular cluster or sample, enter "info
* *Group 2 minus Group 1 Clustering Coefficient*
* *Group 1 Patients* (Sample IDs of the individuals)
* *Group 2 Patients* (Sample IDs of the individuals)

* Output files can be opened from the GUI: select **File > Open** to open a file explorer window.


Expand Down

0 comments on commit 8215a73

Please sign in to comment.