From f5eb29328e911f3f3eb2861143063e24be69869f Mon Sep 17 00:00:00 2001
From: Pradeeban Kathiravelu <kk.pradeeban@gmail.com>
Date: Thu, 23 Sep 2021 14:22:04 -0400
Subject: [PATCH] MRI SUVPaR as a separate module

---
 modules/suvpar/README.md                     | 24 ++++++++++++++++++++
 modules/{app-layer => suvpar}/Strip.py       |  2 +-
 modules/{app-layer => suvpar}/config.json    |  2 +-
 modules/{app-layer => suvpar}/featureset.txt |  0
 modules/{app-layer => suvpar}/sample.csv     |  0
 5 files changed, 26 insertions(+), 2 deletions(-)
 create mode 100644 modules/suvpar/README.md
 rename modules/{app-layer => suvpar}/Strip.py (92%)
 rename modules/{app-layer => suvpar}/config.json (63%)
 rename modules/{app-layer => suvpar}/featureset.txt (100%)
 rename modules/{app-layer => suvpar}/sample.csv (100%)

diff --git a/modules/suvpar/README.md b/modules/suvpar/README.md
new file mode 100644
index 0000000..92ce953
--- /dev/null
+++ b/modules/suvpar/README.md
@@ -0,0 +1,24 @@
+# SUVPaR: Scanner Usage Visualization with PACS and RIS data
+
+This is a module that utilizes Niffler's other modules and (https://github.com/sharmalab/eaglescope)[Eaglescope] to 
+visualize MRI Scanner Usage.
+
+
+# Configuring Niffler SUVPaR
+
+Find the config.json file in the folder and modify accordingly.
+
+* *InputFile*: The metadata in a csv file, as produced by the cold-extraction -> png-extraction workflow.
+
+* *OutputFile*: The output csv file with just the properties listed in the FeaturesetFile.
+
+* *FeaturesetFile*: The subset of the properties that must be stored in the OutputFile.
+
+
+# Running Niffler SUVPaR
+
+First, to run the script to trim the file.
+
+````
+$ python3 Strip.py
+````
\ No newline at end of file
diff --git a/modules/app-layer/Strip.py b/modules/suvpar/Strip.py
similarity index 92%
rename from modules/app-layer/Strip.py
rename to modules/suvpar/Strip.py
index f9963f3..7333283 100644
--- a/modules/app-layer/Strip.py
+++ b/modules/suvpar/Strip.py
@@ -9,7 +9,7 @@ def initialize_config_and_execute():
     with open('config.json', 'r') as f:
         config = json.load(f)
 
-    feature_file = config['FeatureFile']
+    feature_file = config['FeaturesetFile']
     filename = config['InputFile']
     output_csv = config['OutputFile']
 
diff --git a/modules/app-layer/config.json b/modules/suvpar/config.json
similarity index 63%
rename from modules/app-layer/config.json
rename to modules/suvpar/config.json
index ce37307..cc8ee2b 100644
--- a/modules/app-layer/config.json
+++ b/modules/suvpar/config.json
@@ -1,6 +1,6 @@
 {
   "InputFile": "sample.csv",
   "OutputFile": "output.csv",
-  "FeatureFile": "featureset.txt"
+  "FeaturesetFile": "featureset.txt"
 
 }
diff --git a/modules/app-layer/featureset.txt b/modules/suvpar/featureset.txt
similarity index 100%
rename from modules/app-layer/featureset.txt
rename to modules/suvpar/featureset.txt
diff --git a/modules/app-layer/sample.csv b/modules/suvpar/sample.csv
similarity index 100%
rename from modules/app-layer/sample.csv
rename to modules/suvpar/sample.csv