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 bc1ed29 commit 95e58fa
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ To view the summary information for a particular cluster or sample, enter "info

### Selecting Files

* In the GUI, select **File > New analysis**
* In the GUI, select **File > Home**

* Choose the data files for upload. If you are only analyzing one group or a single sample, leave the Geneset File 2 file field empty. NOTE: If you would like to select new Gene Set Files, click on the “Clear Gene Files” button before selecting new Gene Set Files.

Expand All @@ -109,12 +109,13 @@ To view the summary information for a particular cluster or sample, enter "info
### Setting Parameters – Configuration File
* Before running Proteinarium, confirm or make changes to the program’s configurable parameters. A table with all possible parameters, their definitions and their default settings are provided by selecting **Help > Available Configurations**.

* Select **File > Settings** or “Settings” button to view and change parameters. If any changes are made click “Apply Changes” before exiting. NOTE: The values of the parameters for a New Analysis are not all set to the Default values. These are the values used in our testing and validation with bootstrapping turned off (ie 0 iterations).
* Select **File > Settings** or “Settings” button to view and change parameters. If any changes are made click “Apply Changes” before exiting. NOTE: The values of the parameters are not all set to the Default values. These are the values used in our testing and validation with bootstrapping turned off (ie 0 iterations).

* For Advance Settings Select **File > Settings** and click on the “Advance Settings” button. Once changed click on “Set Settings” and the “Apply Changes” buttons.

### 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
Expand All @@ -124,14 +125,18 @@ 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:
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 @@ -151,15 +156,16 @@ To view the summary information for a particular cluster or sample, enter "info

## 4. Change the Parameter Configuration and Re-run Proteinarium:

* Select **File > Home** to return to main screen for running Proteinarium

* Select **File > Settings**

* Change desired parameter values

* Click Apply Changes

* Click “Run Proteinarium” to re-run Proteinarium with new configuration. NOTE: Change Project Name otherwise the previous data will be overwritten.
* Select File > New Analysis to re-run Proteinarium with these new settings

NOTE: Previous data will be overwritten. If you prefer not to overwrite previous data, first select File > Home, make sure gene set files are chosen correctly and change the Project Name. Then adjust parameters with the setting button and click “Run Proteinarium”.




Expand Down

0 comments on commit 95e58fa

Please sign in to comment.