about summary refs log tree commit diff
diff options
context:
space:
mode:
authorziejd22018-04-25 17:09:02 -0500
committerGitHub2018-04-25 17:09:02 -0500
commit787580bae5fe1831dfb15082643bfdbe62bac5fc (patch)
treeaffe0201dacb89ca7960ec3b10df141774cb8aa6
parent02701ec0aff3b8266b4abcb2ee5536ef743e81fb (diff)
downloadBNW-787580bae5fe1831dfb15082643bfdbe62bac5fc.tar.gz
Update README.md
-rw-r--r--README.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/README.md b/README.md
index c290766f..4f5d331e 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,19 @@
 
 This contains the code for the Bayesian Network Webserver (BNW).
 
-The original BNW website is compbio.uthsc.edu/BNW
+The original BNW website is compbio.uthsc.edu/BNW. 
 
 The current development version of BNW is compbio.uthsc.edu/BNW_1.2. I am working on adding cross-validation to this version.
 
-There are a couple of intermediate versions that I kept on the BNW server. Some of them are related to the branches below.
+There are a couple of intermediate versions that I kept on the BNW server. Some of them are related to the branches here. Descriptions of the branches are provided below.
+
+I recently added some text files here that provide more in-depth descriptions of the BNW code.
+These are not very readable, but will hopefully be useful for identifying which files need to be modified when updating BNW.
+-BNW_file_overview.txt lists the files that are needed to run BNW and gives a brief description of the purpose of each file.
+-BNW_data_flow.txt goes through a typical session of BNW describing the order in which codes and scripts are used, as well as when output files are written.
 
 There are four branches.
-1) master: This is compbio.uthsc.edu/BNW_1.12 on the BNW server. It is similar to the octave_php_separate with a couple of additional small changes and bug fixes. I think this version is ready for use as the main BNW.
+1) master: This is currently compbio.uthsc.edu/BNW_1.12 on the BNW server. It is similar to the octave_php_separate with a couple of additional small changes and bug fixes. I think this version is ready for use as the main version of BNW.
 
 2) matlab_original (compbio.uthsc.edu/BNW_1.01): This is functionally identical to the original BNW code. The only difference is that unused files were removed. Currently, compbio.uthsc.edu/BNW redirects to this version.