enh: provide instructions for navigating the dashboard

filter_data_app.py

@@ -102,7 +102,10 @@ def main():
     #df = load_data()
 
     if page == "Plots":
-        st.write("Filter the data based on radiomics feature, qualitative checks, bodyPart, and laterality.")
+        with st.expander("Instructions to navigating the dashboard"):
+            with open("instructions.txt", "r") as file:
+                instructions = file.read()
+            st.write(instructions)
         with st.sidebar:
             st.title("Filters")
 
@@ -371,7 +374,7 @@ def main():
     # Define the pages
     if page == "Summary":
         st.markdown('''
-        This dashboard presents a summary of the following four rule-based checks applied to over 9.5 million segmentations 
+        This page of the dashboard presents a summary of the following four rule-based checks applied to over 9.5 million segmentations 
         from TotalSegmentator(v1) on 125k+ NLST CT scans, displaying the percentage of segmentations passing each check 
         to highlight potential quality issues 
         - segmentation completeness (ensuring empty slices above and below)

instructions.txt

@@ -0,0 +1,41 @@
+
+### Summary for Dashboard Navigation
+
+This tool helps you explore and analyze radiomics data, apply various filters, and visualize the results.
+
+#### Navigation and Features:
+
+**Page Selection**:
+   - **Summary**: Shows the summary in pass percentage of each heurisitic as if applied individually.
+   - **Plots**: Shows detailed visualizations and data filtering options.
+
+**Filters**:
+   - **Radiomics Feature**: Select from various radiomics features (e.g., Volume from Voxel Summation, Mean, Variance).
+   - **Body Part**: Choose the specific body part for analysis.
+   - **Segmentation Completeness, Laterality Check, Volume Check, Connected Volumes**: Filter based on specific qualitative checks.
+   - **Voxel Number**: Filter data based on the range of voxel numbers.
+   - **Radiomics Feature Values**: Set the range for the selected radiomics feature values.
+
+**Filtered Data Display**:
+   - Views a paginated table of filtered data. Please use 'sortby' filter in the sidebar to sort the underlying data.
+   - Includes direct links to the OHIF viewer for each StudyInstanceUID.
+   - Use StudyInstanceUID in combination with Source CT scan's seriesNumber to view the scan of interest.
+
+**Visualizations**:
+   - **Violin Plots**: Shows the distribution of the standard deviation of the selected radiomics feature before and after filtering.
+   - **UpSet Plots**: Visualize intersections of passed and failed qualitative checks.
+
+**Data Download**:
+   - Download the filtered dataset as a CSV file for further analysis.
+
+#### Using the Dashboard:
+
+1. **Select the desired page** from the sidebar.
+2. **Apply filters** as needed using the sidebar options to narrow down your dataset.
+   
+   - **Note**: Please change to a different bodyPart to reset the filters or when you encounter an error message, while we continue improving this dashboard.
+
+3. **View and analyze the data** in the main panel through tables and plots.
+4. **Download the filtered data** for offline analysis.
+
+