citation

Author: sluFicodes

CITATION.cff

@@ -0,0 +1,17 @@
+title: "OpenData: document Analyzer"
+license: MIT
+authors:
+  - family-names: LU
+    given-names: SHENGXING
+cff-version: 1.2.0
+preferred-citation:
+  authors:
+    - family-names: LU
+      given-names: SHENGXING
+  title: "OpenData: document Analyzer"
+  type: article
+  year: 2023
+identifiers:
+  - description: "Project ID"
+    type: doi
+    value: 10.5281/zenodo.7756241

README.md

@@ -83,6 +83,6 @@ If you use our code or results in your research, please cite our paper:
 @article{Opendata,
   title   = {{Opendata}},
   author  = {SHENGXING LU},
-  year    = {2022},
+  year    = {2023},
   doi     = {https://zenodo.org/badge/latestdoi/599152914}
 }

script.py

@@ -53,7 +53,7 @@ def action(folderPath, folderComplPath, wcf, lolf, fpaf):
                 # word cloud from the frequency distribution
                 wordcloud = WordCloud().generate_from_frequencies(freq_dist)
 
-                # save as PNG
+                # save 
                 plt.imshow(wordcloud, interpolation='bilinear')
                 plt.axis("off")
                 plt.savefig(wcf+'/'+ filename[0:filename.find('.')] +'.png')
@@ -68,9 +68,10 @@ def action(folderPath, folderComplPath, wcf, lolf, fpaf):
                 # append the number of figures to the list
                 for i in range(num_figures_in_file):
                     num_figures.append(filename)
+
                 #create list of links
-                
                 f = open(lolf+"/"+  filename[0:filename.find('.')] +'.txt', "w")
+                
                 # find all the biblStruct elements
                 biblstructs = tree.xpath("//tei:biblStruct", namespaces=ns)
 

test/test_script.py

@@ -1,16 +1,11 @@
-# Import necessary modules
-
 import os
 import sys
 from pathlib import Path
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
-# Import the function to test
 from script import action
 
-# Define the test function
 def test_action():
 
-    # Call the function with test inputs
     o = 'test/test_outputs/'
     oh = 'test/test_outputs/test_header/'
     wcf = 'test/test_wordClouds'
@@ -19,7 +14,6 @@ def test_action():
 
     action(oh,o,wcf, lolf, fpaf)
 
-    # Check that the expected files were created
     assert os.path.exists(wcf)
     assert os.path.exists(lolf)
     assert os.path.exists(fpaf)