Update BNW_file_overview.txt

1 files changed, 40 insertions, 29 deletions

diff --git a/BNW_file_overview.txt b/BNW_file_overview.txt
index 4e56d690..fdd429ad 100644
--- a/BNW_file_overview.txt
+++ b/BNW_file_overview.txt
@@ -1,23 +1,3 @@
-Jan. 2019 Update:

-I have added several new files with new features. I will make a major update soon, but here is a list of the new files:

-1) bn_after_upload_gom.php

-2) cross_valid.php; cross_valid_example.php

-3) cv_plotly.py

-4) cv_predictions.php; cv_predictions_example.php

-5) enter_netID.php

-6) input_error.php; input_error_no_menu.php

-7) keyval_error.php

-8) kfold_cv_example.php; kfold_cv.php

-9) kfold_plotly.py

-10) modify_edges.php; modify_edges_processing.php

-11) modify_structure_learning.php

-12) remove_variables.php

-13) remove_variables_processing.php; remove_variables_processing_default.php

-14) test_set_predictions.php; test_set_predictions_example.php

-15) ts_plotly.py

-There are also several new run files: These have been added to the 'run_scripts' sub-directory.

-

-

 This file will provide an overview of the BNW code.

 

 At this point, BNW requires three packages that are not currently included in the BNW directory.

@@ -56,10 +36,11 @@ d) BNW_workflow_test_files, example_datasets, and examples: These three director
 

 e) data: The data for files generated by using BNW is written to this directory. It also contains several sub-directories that contain example data and networks.

 

+f) run_scripts: Scripts that run Octave calculations.

 

 2. Files within sourcecodes:

 a) Major BNW php files:

-Many of these will be described in more detail in another file.

+Many of these will be described in BNW_data_flow.txt.

 bn_file_load_gom.php: Used in uploading data to be used for structure learning.

 create_tiers_gom.php: Structural constraint interface.

 home_upload.php: Used in uploading a data file and a structure file when the structure is known. 

@@ -77,6 +58,7 @@ b) Files related to the structure learning package:
 build.sh

 network_score

 structure

+run.sh

 

 c) Files related to home page, help files, example data sets, and tutorials:

 BNW_overview.png

@@ -103,21 +85,33 @@ add_inv_example.php
 add_inv.php

 network_layout_evd_2_example.php

 network_layout_evd_2.php

-network_layout_evd_2xample.php

+network_layout_evd_example.php

 network_layout_evd.php

 network_layout_inv_2_example.php

 network_layout_inv_2.php

 network_layout_inv_example.php

 network_layout_inv.php

 

-f) Scripts used in structure and parameter learning:

-run_octave: perform parameter learning with original data set and no evidence or intervention

-run_octave_evd: perform parameter learning when considering evidence

-run_octave_inv: perform parameter learning when considering intervention

-run_prep_input: perform prepare data uploaded to BNW for use with structure/parameter learning packages

-run.sh: perform structure learning

+f) Files used for cross-validation/making predictions using a test set:

+cv_predictions.php, cv_predictions_example.php

+-Cross-validations overview page

+

+cross_valid.php, cross_valid_example.php, cv_plotly.py

+-Used for leave-one-out cross-validation

+

+kfold_cv_example.php, kfold_cv.php, kfold_plotly.py

+-Used for k-fold cross-validation

 

-g) Files that perform specific functions:

+test_set_predictions.php, test_set_predictions_example.php, ts_plotly.py

+-Used with test set predictions.

+

+g) Files used in input checking/error processing

+input_error.php

+input_error_no_menu.php

+input_validate.php

+keyval_error.php

+

+h) Files that perform specific functions:

 tier_description_processing_gom.php

 -Used by create_tiers_gom.php for the structure constraint interface.

 

@@ -147,6 +141,23 @@ input_check.php
 parameter_display.php

 -Allows for display of the network parameters of the original data set and after entering evidence/intervention.

 

+enter_netID.php

+-Allows for returning to old network after entering the netID.

+

+modify_structure_learning.php, bn_after_upload_gom.php

+-Allows for modification of structure learning settings without having to upload the file again.

+

+modify_edges.php, modify_edges_processing.php

+-Allows for the removal or addition of specific nodes to a network.

+

+remove_variables.php, remove_variables_processing.php, remove_variables_processing_default.php

+-Allows for the removal of variables after uploading an input file.

+-remove_variables_processing_default.php performs structure learning using defail settings.

+-remove_variables_processing.php goes to the structural constraint interface.

+

+

+

+