Issue#58: Adding Grammar Analyzer feature to GatorMiner

Pipfile

@@ -25,6 +25,8 @@ scipy = "*"
 pylint = "*"
 importlib-metadata = "*"
 atomicwrites = "*"
+language_tool_python = "*"
+
 
 [pipenv]
 allow_prereleases = true

src/grammar_analyzer.py

@@ -0,0 +1,28 @@
+"""Compute and return number of grammar error in text"""
+import language_tool_python
+import re
+
+# Mention the language keyword
+
+
+def grammar_analyzer(text: str) -> int:
+    '''A tool to check grammar error and grade it in the reflection'''
+    tool = language_tool_python.LanguageTool('en-US')
+
+    # Variable represent number of grammar errors in the text
+    err_num = 0
+
+    # count for grammar errors
+    for line in text:
+        matches = tool.check(line)
+        err_num = err_num + len(matches)
+
+    # Store all alphanumeric characters in the reflection in a list
+    words = re.sub('[^0-9a-zA-Z]+', ' ', str(text)).lower().split()
+
+    # Calculate the error percentage of grammar error per number of words
+    err_percentage = 0
+    if len(words) != 0:
+        err_percentage = int(100*err_num/(len(words)))
+
+    return err_num, err_percentage

streamlit_web.py

@@ -20,6 +20,7 @@
 import src.summarizer as sz
 import src.topic_modeling as tm
 import src.visualization as vis
+import src.grammar_analyzer as ga
 
 
 # resources/sample_reflections/lab1, resources/sample_reflections/lab2
@@ -34,7 +35,6 @@
 success_msg = None
 debug_mode = False
 
-
 def main():
     """main streamlit function"""
     # Title
@@ -57,6 +57,7 @@ def main():
                 "Summary",
                 "Topic Modeling",
                 "Interactive",
+                "Grammar Checker"
             ],
         )
         if debug_mode:
@@ -82,6 +83,9 @@ def main():
             elif analysis_mode == "Interactive":
                 st.title(analysis_mode)
                 interactive()
+            elif analysis_mode == "Grammar Checker":
+                st.title(analysis_mode)
+                grammar_analyzer()
             success_msg.empty()
 
 def landing_src():
@@ -653,5 +657,26 @@ def interactive():
         summaries = sz.summarize_text(input_text)
         st.write(summaries)
 
+
+def grammar_analyzer():
+    """page for grammar error checker"""
+    students = st.multiselect(
+        label="Select specific students below:",
+        options=main_df[stu_id].unique(),
+    )
+
+    ga_df = main_df[
+        (main_df[stu_id].isin(students))
+        & main_df[assign_id].isin(assignments)
+    ].dropna(axis=1, how="all")
+
+    # plot all the subplots of different assignments
+    for column in main_df.columns[2:]:
+        ga_df[column] = main_df[column].apply(
+            lambda x: ga.grammar_analyzer(x)
+        )
+    st.write(ga_df)
+
+
 if __name__ == "__main__":
     main()

tests/test_grammar_analyzer.py

@@ -0,0 +1,21 @@
+"""Test case for grammar analyzer feature"""
+import src.grammar_analyzer as ga
+
+
+def test_grammar_analyzer():
+    '''Test if grammar analyzer produce correct error with a short input'''
+    input_text = "This are a pen.\
+                  It is beautifuly."
+    output = ga.grammar_analyzer(input_text)
+    expected = 2, 28
+    assert output == expected
+
+
+def test_grammar_analyzer2():
+    '''Test if grammar analyzer produce correct error with a paragraph input'''
+    input_text = "Python can only interpret names that you have\
+spelled correctly. This is because when you declare a variable or a function,\
+Python store the value with the exact, name you have declared."
+    output = ga.grammar_analyzer(input_text)
+    expected = 4, 12
+    assert output == expected