comparison scripts/generate_report.py @ 1075:056a8454500e

Bug fixes in scripts: display plays in last timeline segment of each fragment (post last move); call sub-processes of generate_report.py in same folder (pass on argument); indentation in LaTeX file.

           at \texttt{code.soundsoftware.ac.uk/projects/webaudioevaluationtool}.
           \tableofcontents
           
           '''
           
-footer = r'''\begin{thebibliography}{9}
+footer = '\n\t\t'+r'''\begin{thebibliography}{9}
          \bibitem{WAET} % reference to accompanying publication
         Nicholas Jillings, Brecht De Man, David Moffat and Joshua D. Reiss, 
         ``Web Audio Evaluation Tool: A browser-based listening test environment,'' 
         presented at the 12th Sound and Music Computing Conference, July 2015.
         \end{thebibliography}

 
 body = ''
 
 # generate images for later use
 if render_figures:
-    subprocess.call("python timeline_view_movement.py", shell=True)
-    subprocess.call("python score_parser.py", shell=True)
-    subprocess.call("python score_plot.py", shell=True)
+    subprocess.call("python timeline_view_movement.py "+folder_name, shell=True)
+    subprocess.call("python score_parser.py "+folder_name, shell=True)
+    subprocess.call("python score_plot.py "+folder_name, shell=True)
 
 # get every XML file in folder
 files_list = os.listdir(folder_name)
 for file in files_list: # iterate over all files in files_list
     if file.endswith(".xml"): # check if XML file
         number_of_XML_files += 1
         tree = ET.parse(folder_name + '/' + file)
         root = tree.getroot()
         
         # PRINT name as section
-        body+= '\section{'+file[:-4].capitalize()+'}\n' # make section header from name without extension
+        body+= '\n\section{'+file[:-4].capitalize()+'}\n' # make section header from name without extension
         
         # reset for new subject
         total_duration = 0
         page_number = 0
         
-        individual_table = '' # table with stats for this individual test file
+        individual_table = '\n' # table with stats for this individual test file
         timeline_plots = '' # plots of timeline (movements and plays)
         
         # DEMO survey stats
         # get gender
         this_subjects_gender = root.find("./posttest/radio/[@id='gender']")

             gender.append('UNAVAILABLE')
         # get age
         this_subjects_age = root.find("./posttest/number/[@id='age']")
         if this_subjects_age is not None:
             age.append(this_subjects_age.text)
-        
+    	#TODO add plot of age
+    	        
         # get list of all page names
         for audioholder in root.findall("./audioholder"):   # iterate over pages
             page_name = audioholder.get('id')               # get page name
             
             if page_name is None: # ignore 'empty' audio_holders

             total_not_moved += len(not_moved)
             
             # PRINT alerts when elements not played or markers not moved
             # number of audio elements not played
             if len(not_played) > 1:
-                body += '\\emph{\\textbf{ATTENTION: '+str(len(not_played))+\
+                body += '\t\t\\emph{\\textbf{ATTENTION: '+str(len(not_played))+\
                         ' fragments were not listened to in '+page_name+'! }}'+\
                         ', '.join(not_played)+'\\\\ \n'
             if len(not_played) == 1: 
-                body += '\\emph{\\textbf{ATTENTION: one fragment was not listened to in '+page_name+'! }}'+\
+                body += '\t\t\\emph{\\textbf{ATTENTION: one fragment was not listened to in '+page_name+'! }}'+\
                         not_played[0]+'\\\\ \n'
             
             # number of audio element markers not moved
             if len(not_moved) > 1:
-                body += '\\emph{\\textbf{ATTENTION: '+str(len(not_moved))+\
+                body += '\t\t\\emph{\\textbf{ATTENTION: '+str(len(not_moved))+\
                         ' markers were not moved in '+page_name+'! }}'+\
                         ', '.join(not_moved)+'\\\\ \n'
             if len(not_moved) == 1: 
-                body += '\\emph{\\textbf{ATTENTION: one marker was not moved in '+page_name+'! }}'+\
+                body += '\t\t\\emph{\\textbf{ATTENTION: one marker was not moved in '+page_name+'! }}'+\
                         not_moved[0]+'\\\\ \n'
             
             # PRINT song-specific statistic
-            individual_table += page_name+'&'+\
+            individual_table += '\t\t'+page_name+'&'+\
                                 str(number_of_comments) + '/' +\
                                 str(number_of_comments+number_of_missing_comments)+'&'+\
-                                seconds2timestr(duration)+'\\\\'
+                                seconds2timestr(duration)+'\\\\\n'
             
             # get timeline for this audioholder
             img_path = 'timelines_movement/'+file[:-4]+'-'+page_name+'.pdf'
             
             # check if available
             if os.path.isfile(folder_name+'/'+img_path):
                 # SHOW timeline image
                 timeline_plots += '\\includegraphics[width=\\textwidth]{'+\
-                         folder_name+'/'+img_path+'}\n\n'
+                         folder_name+'/'+img_path+'}\n\t\t'
             
             # keep track of duration in function of page index
             if len(duration_order)>page_number:
                 duration_order[page_number].append(duration)
             else:

             page_number += 1 # increase page count for this specific test
             number_of_pages += 1 # increase total number of pages
             time_per_page_accum += duration # total duration (for average time spent per page)
 
         # PRINT table with statistics about this test
-        body += r'''\begin{tabular}{|p{3.5cm}|c|p{2.5cm}|}
+        body += '\t\t'+r'''\begin{tabular}{|p{3.5cm}|c|p{2.5cm}|}
                  \hline
                  \textbf{Song name} & \textbf{Comments} & \textbf{Duration} \\ \hline '''+\
-                 individual_table+\
+                 individual_table+'\t\t'+\
                  r'''\hline
                   \textbf{TOTAL} & & \textbf{'''+\
                   seconds2timestr(total_duration)+\
                  r'''}\\
                   \hline 

 # empty body again
 body = ''
 
 # PRINT summary of everything (at start) 
 #       unnumbered so that number of sections equals number of files
-body += '\section*{Summary}\n\\addcontentsline{toc}{section}{Summary}'
+body += '\section*{Summary}\n\t\t\\addcontentsline{toc}{section}{Summary}\n'
 
 # PRINT table with statistics
-body += '\\begin{tabular}{ll}'
-body += r'Number of XML files: &' + str(number_of_XML_files) + r'\\'
-body += r'Number of pages: &' + str(number_of_pages) + r'\\'
-body += r'Number of fragments: &' + str(number_of_fragments) + r'\\'
+body += '\t\t\\begin{tabular}{ll}\n\t\t\t'
+body += r'Number of XML files: &' + str(number_of_XML_files) + r'\\'+'\n\t\t\t'
+body += r'Number of pages: &' + str(number_of_pages) + r'\\'+'\n\t\t\t'
+body += r'Number of fragments: &' + str(number_of_fragments) + r'\\'+'\n\t\t\t'
 body += r'Number of empty comments: &' + str(total_empty_comments) +\
-      " (" + str(round(100.0*total_empty_comments/number_of_fragments,2)) + r"\%)\\"
+      " (" + str(round(100.0*total_empty_comments/number_of_fragments,2)) + r"\%)\\"+'\n\t\t\t'
 body += r'Number of unplayed fragments: &' + str(total_not_played) +\
-      " (" + str(round(100.0*total_not_played/number_of_fragments,2)) + r"\%)\\"
+      " (" + str(round(100.0*total_not_played/number_of_fragments,2)) + r"\%)\\"+'\n\t\t\t'
 body += r'Number of unmoved markers: &' + str(total_not_moved) +\
-      " (" + str(round(100.0*total_not_moved/number_of_fragments,2)) + r"\%)\\"
-body += r'Average time per page: &' + seconds2timestr(time_per_page_accum/number_of_pages) + r"\\"
+      " (" + str(round(100.0*total_not_moved/number_of_fragments,2)) + r"\%)\\"+'\n\t\t\t'
+body += r'Average time per page: &' + seconds2timestr(time_per_page_accum/number_of_pages) + r"\\"+'\n\t\t'
 body += '\\end{tabular} \\vspace{1.5cm} \\\\ \n'
 
 # Average duration for first, second, ... page
-body += " \\vspace{.5cm} Average duration per page (see also Figure \\ref{fig:avgtimeperpage}): \\\\ \n"
+body += "\t\t\\vspace{.5cm} \n\n\t\tAverage duration per page (see also Figure \\ref{fig:avgtimeperpage}): \\\\ \n\t\t"
 body += r'''\begin{tabular}{lll}
-        \textbf{Page} & \textbf{Duration} & \textbf{\# subjects}\\
-        '''
+                    \textbf{Page} & \textbf{Duration} & \textbf{\# subjects}\\'''
 tpp_averages = [] # store average time per page
 for page_number in range(len(duration_order)): 
-    body += str(page_number+1) + "&" +\
+    body += '\n\t\t\t'+str(page_number+1) + "&" +\
         seconds2timestr(sum(duration_order[page_number])/len(duration_order[page_number])) +\
             "&"+str(len(duration_order[page_number]))+r"\\"
     tpp_averages.append(sum(duration_order[page_number])/len(duration_order[page_number]))
             
-body += '\\end{tabular} \\vspace{1.5cm} \\\\ \n'
+body += '\n\t\t\\end{tabular} \\vspace{1.5cm} \\\\ \n\n\t\t'
 
 # SHOW bar plot of average time per page
 plt.bar(range(1,len(duration_order)+1), np.array(tpp_averages)/60)
 plt.xlabel('Page order')
 plt.xlim(.8, len(duration_order)+1)

 # combine and sort in function of number of audioelements and duration
 combined_list = [page_names, average_duration_page, fragments_per_page, number_of_subjects_page]
 combined_list = sorted(zip(*combined_list), key=operator.itemgetter(1, 2)) # sort
 
 # Show average duration for all songs
-body += r'''\vspace{.5cm} Average duration per audioholder (see also Figure \ref{fig:avgtimeperaudioholder}): \\
-        \begin{tabular}{llll}
-        \textbf{Audioholder} & \textbf{Duration} & \textbf{\# subjects} & \textbf{\# fragments} \\
-        '''
+body += r'''\vspace{.5cm}
+                Average duration per audioholder (see also Figure \ref{fig:avgtimeperaudioholder}): \\
+                \begin{tabular}{llll}
+                        \textbf{Audioholder} & \textbf{Duration} & \textbf{\# subjects} & \textbf{\# fragments} \\'''
 audioholder_names_ordered = []
 average_duration_audioholder_ordered = []
 number_of_subjects = []
 for page_index in range(len(page_names)):
     audioholder_names_ordered.append(combined_list[page_index][0])
     average_duration_audioholder_ordered.append(combined_list[page_index][1])
     number_of_subjects.append(combined_list[page_index][3])
-    body +=  combined_list[page_index][0] + "&" +\
+    body +=  '\n\t\t\t'+combined_list[page_index][0] + "&" +\
              seconds2timestr(combined_list[page_index][1]) + "&" +\
              str(combined_list[page_index][3]) + "&" +\
              str(combined_list[page_index][2]) + r"\\"
-body += '\\end{tabular}\n'
+body += '\n\t\t\\end{tabular}\n'
 
 # SHOW bar plot of average time per page
 plt.bar(range(1,len(audioholder_names_ordered)+1), np.array(average_duration_audioholder_ordered)/60)
 plt.xlabel('Audioholder')
 plt.xlim(.8, len(audioholder_names_ordered)+1)

 plt.yticks(yint)
 plt.savefig(folder_name+"/subjects_per_audioholder.pdf", bbox_inches='tight')
 plt.close()
 
 # SHOW both figures
-body += r'''\begin{figure}[htbp]
+body += r'''
+         \begin{figure}[htbp]
          \begin{center}
          \includegraphics[width=.65\textwidth]{'''+\
          folder_name+"/time_per_page.pdf"+\
         r'''}
         \caption{Average time spent per page.}
         \label{fig:avgtimeperpage}
          \end{center}
          \end{figure}
+         
          '''
 body += r'''\begin{figure}[htbp]
          \begin{center}
          \includegraphics[width=.65\textwidth]{'''+\
          folder_name+"/time_per_audioholder.pdf"+\
         r'''}
         \caption{Average time spent per audioholder.}
         \label{fig:avgtimeperaudioholder}
          \end{center}
          \end{figure}
+         
          '''
 body += r'''\begin{figure}[htbp]
          \begin{center}
          \includegraphics[width=.65\textwidth]{'''+\
          folder_name+"/subjects_per_audioholder.pdf"+\
         r'''}
         \caption{Number of subjects per audioholder.}
         \label{fig:avgtimeperaudioholder}
          \end{center}
          \end{figure}
+         
          '''
 #TODO add error bars
 #TODO layout of figures
 
 # SHOW boxplot per audioholder

             audioholder_name+' ('+str(subject_count[real_page_names.index(audioholder_name)])+\
             ''' participants).}
             \label{fig:avgtimeperpage}
              \end{center}
              \end{figure}
+             
              '''
 
 # DEMO pie chart of gender distribution among subjects
 genders = ['male', 'female', 'other', 'preferNotToSay', 'UNAVAILABLE']
 # TODO: get the above automatically

     if number>0:
         gender_distribution += str("{:.2f}".format((100.0*number)/len(gender)))+\
                                '/'+item.capitalize()+' ('+str(number)+'),\n'
 
 body += r'''
+        % Pie chart of gender distribution
         \def\angle{0}
         \def\radius{3}
         \def\cyclelist{{"orange","blue","red","green"}}
         \newcount\cyclecount \cyclecount=-1
         \newcount\ind \ind=-1

         \end{tikzpicture}
         \caption{Representation of gender across subjects}
         \label{default}
         \end{center}
         \end{figure}
+        
         '''
 # problem: some people entered twice? 
 
 #TODO
 # time per page in function of number of fragments (plot)