Minor formatting updates for the latest version

ajnetzley · Jan 15, 2025 · 4109684 · 4109684
1 parent 3a32b7f
commit 4109684
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -32,7 +32,11 @@ streamlit run app/app.py
 Upon opening the app, you are directed to the Login page, where you enter a name. Next, you are directed to the Folder Selection page, where you are prompted to enter the path to the location of the ichorCNA output data. This should be a folder containing a subfolder for each of the samples that was run through ichorCNA. Then, optionally, you can input a path for where the output curated solutions will be written to. If you don't enter a path, a folder at your working directory named "curated_solutions/" will be created and used.
 
 ### Step 4) Curation, Navigation, and Exporting
-Next, you are directed to the Tracker Dashboard page, which contains a summary dashboard overview of all of your present samples and their curation status. Here, users can chose to begin curation by selecting a sample, or directly export the "default" solution without curating. After selecting a sample to curate, you are directed to the Curation page, where you can begin visualizing the CNA plots. Specifically, you can toggle between all potential solutions, zoom in on any chromosome, and select a temporary selected solution for comparison. After confirming your selection, you can officially "Set as Curated Solution" to complete the curation, which sends you back to the Tracker Dashboard. After curating, you can select the "export" button to export the curated solution to the output folder.
+Next, you are directed to the Tracker Dashboard page, which contains a summary dashboard overview of all of your samples and their curation status. Here, users can chose to begin curation by selecting a sample, or directly export the "default" solution without curating. 
+
+After selecting a sample to curate, you are directed to the Curation page, where you can begin visualizing the CNA plots. Specifically, you can toggle between all potential solutions, zoom in on any chromosome, and select a temporary selected solution for comparison. Additionally, users have the option to select a reference curated solution (from a different sample, perhaps the same patient) to aid in curation. After confirming your selection, you can officially "Set as Curated Solution" to complete the curation, which sends you back to the Tracker Dashboard. 
+
+After curating, you can select the "export" button to export the curated solution for that sample to the output folder. Additionally, you can select the "Export Curation Summary" button to produce a .txt curation summary file, or "Export All Samples" or "Export All Curated Samples" for exporting in bulk.
 
 
 ## Repository Structure

diff --git a/app/app.py b/app/app.py
@@ -1,6 +1,6 @@
 """
 app.py
-v0.1.0, 12/9/2024
+v0.2.0, 1/15/2025
 Author: Alexander Netzley, [email protected]
 Ha Lab, Fred Hutchinson Cancer Research Center
 

diff --git a/app/pages/curation.py b/app/pages/curation.py
@@ -1,6 +1,6 @@
 """
 curation.py
-v0.1.0, 12/9/2024
+v0.2.0, 1/15/2025
 Author: Alexander Netzley, [email protected]
 Ha Lab, Fred Hutchinson Cancer Research Center
 
@@ -197,5 +197,4 @@ def display():
                 st.rerun()  # Refresh the app to load the tracker dashboard page
 
         else:
-            st.write("No solution selected.")
-
+            st.write("No solution selected.")
diff --git a/app/pages/folder_selection.py b/app/pages/folder_selection.py
@@ -1,6 +1,6 @@
 """
 login.py
-v0.1.0, 12/9/2024
+v0.2.0, 1/15/2025
 Author: Alexander Netzley, [email protected]
 Ha Lab, Fred Hutchinson Cancer Research Center
 

diff --git a/app/pages/login.py b/app/pages/login.py
@@ -1,6 +1,6 @@
 """
 login.py
-v0.1.0, 12/9/2024
+v0.2.0, 1/15/2025
 Author: Alexander Netzley, [email protected]
 Ha Lab, Fred Hutchinson Cancer Research Center
 

diff --git a/app/pages/tracker_dashboard.py b/app/pages/tracker_dashboard.py
@@ -1,6 +1,6 @@
 """
 tracker_dashboard.py
-v0.1.0, 12/9/2024
+v0.2.0, 1/15/2025
 Author: Alexander Netzley, [email protected]
 Ha Lab, Fred Hutchinson Cancer Research Center
 

diff --git a/app/src/utils.py b/app/src/utils.py
@@ -1,6 +1,6 @@
 """
 utils.py
-v0.1.0, 12/9/2024
+v0.2.0, 1/15/2025
 Author: Alexander Netzley, [email protected]
 Ha Lab, Fred Hutchinson Cancer Research Center