about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAlexander_Kabui <alexanderkabua@gmail.com>2022-08-05 11:56:27 +0300
committerAlexander_Kabui <alexanderkabua@gmail.com>2022-08-05 11:56:27 +0300
commitb53e2fbbd484ed030aef5500b8670f0d3eeec2ec (patch)
tree35a53fe4769380aba89b9960f831efef96c91c82
parent4f73a3f024fc0dc74bbe4d8b02f0eb83b6516485 (diff)
downloadcorrelation_rust-b53e2fbbd484ed030aef5500b8670f0d3eeec2ec.tar.gz
update docs
-rw-r--r--README.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3754826..0b03c51 100644
--- a/README.md
+++ b/README.md
@@ -25,13 +25,16 @@ expected dataset file example see --> ./tests/data/dataset_with_nans.txt
 ``` json
 
 //example.json
+
 {
-    "file_path":"/home/kabui/correlation_rust/tests/data/matrix_80.txt", //dataset path
-    "x_vals":"25.08439, 72.02225, 47.56293, 22.87893, 14.28721, 71.84655, 87.81991, 84.86824, 6.72478, 5.72373, 73.47078, 63.74703", //x-vals primary values
-    "method":"pearson",  //spearman or pearson
-    "file_delimiter":","  //need to parse file e.g "12| 212| 212|" delimiter=|
+    "file_path":"/home/kabui/correlation_rust/tests/data/db300.txt", //bath to dataset file
+    "x_vals":"25.08439, 72.02225, 47.56293, 22.87893, 14.28721, 71.84655, 87.81991, 84.86824, 6.72478, 5.72373, 73.47078, 63.74703",
+    "sample_values":"bxd1", //do be implemented 
+    "method":"pearson",  //method implemented are pearson and spearman
+    "file_delimiter":",",  //needed to parse file e.g 12|212|212 delimiter=1
+    "output_file":"/home/kabui/correlation_rust/output.txt" //generic path to ouput results
+ }
 
-}
 
 ```