--- loncom/interface/statistics/lonstudentassessment.pm 2002/07/26 16:22:09 1.3 +++ loncom/interface/statistics/lonstudentassessment.pm 2003/03/06 21:12:54 1.36 @@ -1,12 +1,10 @@ # The LearningOnline Network with CAPA -# (Publication Handler # -# $Id: lonstudentassessment.pm,v 1.3 2002/07/26 16:22:09 stredwic Exp $ +# $Id: lonstudentassessment.pm,v 1.36 2003/03/06 21:12:54 matthew Exp $ # # Copyright Michigan State University Board of Trustees # # This file is part of the LearningOnline Network with CAPA (LON-CAPA). -# # LON-CAPA is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or @@ -26,605 +24,1043 @@ # http://www.lon-capa.org/ # # (Navigate problems for statistical reports -# YEAR=2001 -# 5/5,7/9,7/25/1,8/11,9/13,9/26,10/5,10/9,10/22,10/26 Behrouz Minaei -# 11/1,11/4,11/16,12/14,12/16,12/18,12/20,12/31 Behrouz Minaei -# YEAR=2002 -# 1/22,2/1,2/6,2/25,3/2,3/6,3/17,3/21,3/22,3/26,4/7,5/6 Behrouz Minaei -# 5/12,5/14,5/15,5/19,5/26,7/16 Behrouz Minaei # -### +####################################################### +####################################################### + +=pod + +=head1 NAME + +lonstudentassessment + +=head1 SYNOPSIS + +Presents assessment data about a student or a group of students. + +=head1 Subroutines -package Apache::lonstudentassessment; +=over 4 + +=cut + +####################################################### +####################################################### + +package Apache::lonstudentassessment; use strict; +use Apache::lonstatistics; use Apache::lonhtmlcommon; use Apache::loncoursedata; -use GDBM_File; +use Apache::lonnet; # for logging porpoises +use Spreadsheet::WriteExcel; -sub BuildStudentAssessmentPage { - my ($cacheDB,$students,$courseID,$formName,$headings,$spacing, - $studentInformation,$r,$c)=@_; +####################################################### +####################################################### +=pod - my %cache; - unless(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) { - $r->print('Unable to tie database.'); - return; - } +=item Package Variables - # Remove students who don't have the proper section. - my @sectionsSelected = split(':',$cache{'sectionsSelected'}); - for(my $studentIndex=((scalar @$students)-1); $studentIndex>=0; - $studentIndex--) { - my $value = $cache{$students->[$studentIndex].':section'}; - my $found = 0; - foreach (@sectionsSelected) { - if($_ eq 'none') { - if($value eq '' || !defined($value) || $value eq ' ') { - $found = 1; - last; - } - } else { - if($value eq $_) { - $found = 1; - last; - } - } - } - if($found == 0) { - splice(@$students, $studentIndex, 1); - } - } +=over 4 - my $selectedName = &FindSelectedStudent(\%cache, - $cache{'StudentAssessmentStudent'}, - $students); - $r->print(&CreateInterface(\%cache, $selectedName, $students, $formName)); +=item $Statistics Hash ref to store student data. Indexed by symb, + contains hashes with keys 'score' and 'max'. - my $Ptr = ''; - if($selectedName eq 'No Student Selected') { - $Ptr .= '

WARNING: '; - $Ptr .= 'Please select a student

'; - $r->print($Ptr); - return; - } +=cut - my ($infoHeadings, $infoKeys, $sequenceHeadings, $sequenceKeys) = - &ShouldShowColumns(\%cache, $headings, $studentInformation); +####################################################### +####################################################### - $r->print(&CreateTableHeadings(\%cache, $spacing, $infoKeys, $infoHeadings, - $sequenceKeys, $sequenceHeadings)); - untie(%cache); - - my $selected=0; - $r->print('
'."\n");
-    foreach (@$students) {
-        next if ($_ ne $selectedName && 
-                 $selectedName ne 'All Students');
-        $selected = 1;
-        my $courseData; 
-        if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) {
-            if($cache{$_.':lastDownloadTime'} eq 'Not downloaded') {
-                untie(%cache);
-                $courseData = 
-                    &Apache::loncoursedata::DownloadCourseInformation($_, 
-                                                                    $courseID);
-                if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_WRCREAT,0640)) {
-                    &Apache::loncoursedata::ProcessStudentData(\%cache, 
-                                                             $courseData, $_);
-                    untie(%cache);
-                } else {
-                    last if($c->aborted());
-                    next;
-                }
-            } else {
-                untie(%cache);
-            }
-        } else {
-            last if($c->aborted());
-            next;
-        }
+my $Statistics;
 
-        last if ($c->aborted());
+#######################################################
+#######################################################
 
-        if(tie(%cache,'GDBM_File',$cacheDB,&GDBM_READER,0640)) {
-            my $displayString = 'DISPLAYDATA'.$spacing;
-            $r->print(&Apache::lonhtmlcommon::FormatStudentInformation(
-                                                         \%cache, $_,
-                                                         $infoKeys,
-                                                         $displayString,
-                                                         'preformatted'));
-            $r->print(&StudentReport(\%cache, $_, $spacing, $sequenceKeys));
-            $r->print("\n");
-            untie(%cache);
-        }
-    }
-    $r->print('
'."\n"); - if($selected == 0) { - $Ptr .= '

WARNING: '; - $Ptr .= 'Please select a student

'; - $r->print($Ptr); - } +=pod - return; -} +=item $show_links 'yes' or 'no' for linking to student performance data -#---- Student Assessment Web Page -------------------------------------------- +=item $output_mode 'html', 'excel', or 'csv' for output mode -sub CreateInterface { - my($cache,$selectedName,$students,$formName)=@_; - my $Ptr = ''; - $Ptr .= &CreateLegend(); - $Ptr .= '
'."\n"; - $Ptr .= '{'sectionList'}); - my @selectedSections = split(':',$cache->{'sectionsSelected'}); - $Ptr .= &Apache::lonhtmlcommon::MultipleSectionSelect(\@sections, - \@selectedSections, - 'Statistics'); - $Ptr .= '
'."\n"; - - return $Ptr; -} - -sub CreateTableHeadings { - my($cache,$spacing,$infoKeys,$infoHeadings,$sequenceKeys, - $sequenceHeadings)=@_; +=item $show 'all', 'totals', or 'scores' determines how much data is output - my $Str = ''; - $Str .= ''."\n"; +=cut - my $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $infoKeys, - $infoHeadings, - $displayString, - 'preformatted'); - - $displayString = ''."\n"; - $Str .= &Apache::lonhtmlcommon::CreateHeadings($cache, - $sequenceKeys, - $sequenceHeadings, - $displayString, - 'preformatted'); +####################################################### +####################################################### +my $show_links; +my $output_mode; +my $show; + +####################################################### +####################################################### +# End of package variable declarations - $Str .= ''; - $Str .= '
DISPLAYDATAFORMATTING';
-    $displayString .= $spacing.'
DISPLAYDATA'.$spacing;
-    $displayString .= '
Total Solved/Total Problems
'."\n"; +=pod - return $Str; -} +=back + +=cut + +####################################################### +####################################################### =pod -=item &FormatStudentData() +=item &BuildStudentAssessmentPage() -First, FormatStudentInformation is called and prefixes the course information. -This function produces a formatted string of the student's course information. -Each column of data represents all the problems for a given sequence. For -valid grade data, a link is created for that problem to a submission record -for that problem. +Inputs: =over 4 -Input: $name, $studentInformation, $ChartDB +=item $r Apache Request -$name: The name and domain of the current student in name:domain format +=item $c Apache Connection -$studentInformation: A pointer to an array holding the names used to -remove data from the hash. They represent -the name of the data to be removed. +=back -$ChartDB: The name of the cached data database which will be tied to that -database. +=cut -Output: $Str +####################################################### +####################################################### +sub BuildStudentAssessmentPage { + my ($r,$c)=@_; + undef($Statistics); + # + # Print out the HTML headers for the interface + # This also parses the output mode selector + # This step must always be done. + $r->print(&CreateInterface()); + $r->print(''); + $r->rflush(); + if (! exists($ENV{'form.notfirstrun'})) { + $r->print(< + +Please make your selections in the boxes above and hit +the button marked "Update Display". + +

+ENDMSG +# $r->print(&OutputDescriptions()); + return; + } + # + # + my $initialize = \&html_initialize; + my $output_student = \&html_outputstudent; + my $finish = \&html_finish; + # + if ($output_mode eq 'excel') { + $initialize = \&excel_initialize; + $output_student = \&excel_outputstudent; + $finish = \&excel_finish; + } elsif ($output_mode eq 'multi-sheet excel') { + $initialize = \&multi_sheet_excel_initialize; + $output_student = \&multi_sheet_excel_outputstudent; + $finish = \&multi_sheet_excel_finish; + } elsif ($output_mode eq 'csv') { + $initialize = \&csv_initialize; + $output_student = \&csv_outputstudent; + $finish = \&csv_finish; + } + # + if($c->aborted()) { return ; } + # + # Call the initialize routine selected above + $initialize->($r); + foreach my $student (@Apache::lonstatistics::Students) { + if($c->aborted()) { + $finish->($r); + return ; + } + # Call the output_student routine selected above + $output_student->($r,$student); + } + # Call the "finish" routine selected above + $finish->($r); + # + return; +} -$Str: Formatted string that is an entire row of the chart. It is a -concatenation of student information and student course information. +####################################################### +####################################################### -=back +sub get_student_fields_to_show { + my @to_show = @Apache::lonstatistics::SelectedStudentData; + foreach (@to_show) { + if ($_ eq 'all') { + @to_show = @Apache::lonstatistics::StudentDataOrder; + last; + } + } + return @to_show; +} -=cut +sub get_sequences_to_show { + my @Sequences; + foreach my $map_symb (@Apache::lonstatistics::SelectedMaps) { + foreach my $sequence (@Apache::lonstatistics::Sequences) { + next if ($sequence->{'symb'} ne $map_symb && $map_symb ne 'all'); + next if ($sequence->{'num_assess'} < 1); + push (@Sequences,$sequence); + } + } + return @Sequences; +} -sub StudentReport { - my ($cache,$name,$spacing,$showSequences)=@_; - my ($username,$domain)=split(':',$name); - my $Str = ''; - if($cache->{$name.':error'} =~ /course/) { - $Str .= 'No course data for student '; - $Str .= ''.$username.'.
'; - return $Str; - } - - my $Version; - my $problemsCorrect = 0; - my $totalProblems = 0; - my $problemsSolved = 0; - my $numberOfParts = 0; -# foreach my $sequence (split(':', $cache->{'orderedSequences'})) { - foreach my $sequence (@$showSequences) { - my $characterCount=0; - foreach my $problemID (split(':', $cache->{$sequence.':problems'})) { - my $problem = $cache->{$problemID.':problem'}; - my $LatestVersion = $cache->{$name.':version:'.$problem}; - - # Output dashes for all the parts of this problem if there - # is no version information about the current problem. - if(!$LatestVersion) { - foreach my $part (split(/\:/,$cache->{$sequence.':'. - $problemID. - ':parts'})) { - $Str .= ' '; - $totalProblems++; - $characterCount++; - } - next; - } +####################################################### +####################################################### - my %partData=undef; - # Initialize part data, display skips correctly - # Skip refers to when a student made no submissions on that - # part/problem. - foreach my $part (split(/\:/,$cache->{$sequence.':'. - $problemID. - ':parts'})) { - $partData{$part.':tries'}=0; - $partData{$part.':code'}=' '; - } +=pod - # Looping through all the versions of each part, starting with the - # oldest version. Basically, it gets the most recent - # set of grade data for each part. - for(my $Version=1; $Version<=$LatestVersion; $Version++) { - foreach my $part (split(/\:/,$cache->{$sequence.':'. - $problemID. - ':parts'})) { - - if(!defined($cache->{$name.":$Version:$problem". - ":resource.$part.solved"})) { - # No grade for this submission, so skip - next; - } +=item &CreateInterface() - my $tries=0; - my $code=' '; +Called by &BuildStudentAssessmentPage to create the top part of the +page which displays the chart. - $tries = $cache->{$name.':'.$Version.':'.$problem. - ':resource.'.$part.'.tries'}; - $partData{$part.':tries'}=($tries) ? $tries : 0; - - my $val = $cache->{$name.':'.$Version.':'.$problem. - ':resource.'.$part.'.solved'}; - if ($val eq 'correct_by_student') {$code = '*';} - elsif ($val eq 'correct_by_override') {$code = '+';} - elsif ($val eq 'incorrect_attempted') {$code = '.';} - elsif ($val eq 'incorrect_by_override'){$code = '-';} - elsif ($val eq 'excused') {$code = 'x';} - elsif ($val eq 'ungraded_attempted') {$code = '#';} - else {$code = ' ';} - $partData{$part.':code'}=$code; - } - } +Inputs: None - # All grades (except for versionless parts) are displayed as links - # to their submission record. Loop through all the parts for the - # current problem in the correct order and prepare the output links - $Str .= ''; - foreach(split(/\:/,$cache->{$sequence.':'.$problemID. - ':parts'})) { - if($partData{$_.':code'} eq '*') { - $problemsCorrect++; - if (($partData{$_.':tries'}<10) && - ($partData{$_.':tries'} ne '')) { - $partData{$_.':code'}=$partData{$_.':tries'}; - } - } elsif($partData{$_.':code'} eq '+') { - $problemsCorrect++; - } +Returns: A string containing the HTML for the headers and top table for +the chart page. - $Str .= $partData{$_.':code'}; - $characterCount++; +=cut - if($partData{$_.':code'} ne 'x') { - $totalProblems++; - } - } - $Str.=''; +####################################################### +####################################################### +sub CreateInterface { + my $Str = ''; +# $Str .= &CreateLegend(); + $Str .= ''."\n"; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''; + $Str .= ''."\n"; + # + $Str .= ''."\n"; + $Str .= '
SectionsStudent DataProblem SetsOutput Format
'."\n"; + $Str .= &Apache::lonstatistics::SectionSelect('Section','multiple',5); + $Str .= ''; + my $only_seq_with_assessments = sub { + my $s=shift; + if ($s->{'num_assess'} < 1) { + return 0; + } else { + return 1; } + }; + $Str .= &Apache::lonstatistics::StudentDataSelect('StudentData','multiple', + 5,undef); + $Str .= ''."\n"; + $Str .= &Apache::lonstatistics::MapSelect('Maps','multiple,all',5, + $only_seq_with_assessments); + $Str .= ''."\n"; + $Str .= &CreateAndParseOutputSelector(); + $Str .= '
'."\n"; + return $Str; +} + +####################################################### +####################################################### + +=pod + +=item &CreateAndParseOutputSelector() + +=cut - # Output the number of correct answers for the current sequence. - # This part takes up 6 character slots, but is formated right - # justified. - my $spacesNeeded=$cache->{$sequence.':columnWidth'}-$characterCount; - $spacesNeeded -= 3; - $Str .= (' 'x$spacesNeeded); - - my $outputProblemsCorrect = sprintf( "%3d", $problemsCorrect ); - $Str .= ''.$outputProblemsCorrect.''; - $problemsSolved += $problemsCorrect; - $problemsCorrect=0; - - $Str .= $spacing; - } - - # Output the total correct problems over the total number of problems. - # I don't like this type of formatting, but it is a solution. Need - # a way to dynamically determine the space requirements. - my $outputProblemsSolved = sprintf( "%4d", $problemsSolved ); - my $outputTotalProblems = sprintf( "%4d", $totalProblems ); - $Str .= ''.$outputProblemsSolved. - ' / '.$outputTotalProblems.''; +####################################################### +####################################################### +my @OutputOptions = + ({ name => 'HTML, with links', + value => 'html, with links', + description => 'Output HTML with each symbol linked to the problem '. + 'which generated it.', + mode => 'html', + show => 'all', + show_links => 'yes', + }, + { name => 'HTML, without links', + value => 'html, without links', + description => 'Output HTML. By not including links, the size of the'. + ' web page is greatly reduced. If your browser crashes on the '. + 'full display, try this.', + mode => 'html', + show => 'all', + show_links => 'no', + }, + { name => 'HTML, scores only', + value => 'html, scores only', + description => 'Output HTML, only showing the total number of correct'. + ' problems (or problem parts) and not the maximum possible for '. + 'each student', + mode => 'html', + show => 'scores', + show_links => 'no', + }, + { name => 'HTML, totals', + value => 'html, totals', + description => 'Output HTML, but only the summary statistics for each'. + ' sequence selected.', + mode => 'html', + show => 'totals', + show_links => 'no', + }, + { name => 'Excel, scores only', + value => 'excel, scores only', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with a single column for each sequence showing the students '. + 'score.', + mode => 'excel', + show => 'scores', + show_links => 'no', + }, + { name => 'Excel, totals', + value => 'excel, totals', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with two columns for each sequence, the students score on the '. + 'sequence and the students maximum possible on the sequence', + mode => 'excel', + show => 'totals', + show_links => 'no', + }, + { name => 'multi-sheet Excel', + value => 'multi-sheet excel', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with a seperate worksheet for each sequence you have selected '. + 'the data for each problem part '. + '(number of tries, status, points awarded) will be listed.', + mode => 'multi-sheet excel', + show => 'totals', + show_links => 'no', + }, + { name => 'multi-sheet Excel, by section', + value => 'multi-sheet excel, by section', + description => 'Output an Excel file (compatable with Excel 95), '. + 'with a seperate worksheet for each sequence you have selected '. + 'the data for each problem part '. + '(number of tries, status, points awarded) will be listed. '. + 'There will be one Excel workbook for each section selected.', + mode => 'multi-sheet excel', + show => 'by section', + show_links => 'no', + }, + { name => 'CSV, everything', + value => 'csv, everything', + description => '', + mode => 'csv', + show => 'all', + show_links => 'no', + }, + { name => 'CSV, scores only', + value => 'csv, scores only', + description => '', + mode => 'csv', + show => 'scores', + show_links => 'no', + }, + { name => 'CSV, totals', + value => 'csv, totals', + description => '', + mode => 'csv', + show => 'totals', + show_links => 'no', + }, + ); +sub OutputDescriptions { + my $Str = ''; + $Str .= "

Output Modes

\n"; + $Str .= "
\n"; + foreach my $outputmode (@OutputOptions) { + $Str .="
".$outputmode->{'name'}."
\n"; + $Str .="
".$outputmode->{'description'}."
\n"; + } + $Str .= "
\n"; return $Str; } +sub CreateAndParseOutputSelector { + my $Str = ''; + my $elementname = 'outputmode'; + # + # Format for output options is 'mode, restrictions'; + my $selected = 'html, with links'; + if (exists($ENV{'form.'.$elementname})) { + if (ref($ENV{'form.'.$elementname} eq 'ARRAY')) { + $selected = $ENV{'form.'.$elementname}->[0]; + } else { + $selected = $ENV{'form.'.$elementname}; + } + } + # + # Set package variables describing output mode + $show_links = 'no'; + $output_mode = 'html'; + $show = 'all'; + foreach my $option (@OutputOptions) { + next if ($option->{'value'} ne $selected); + $output_mode = $option->{'mode'}; + $show = $option->{'show'}; + $show_links = $option->{'show_links'}; + } + + # + # Build the form element + $Str = qq/"; + return $Str; +} + +####################################################### +####################################################### + =pod -=item &CreateLegend() +=head2 HTML output routines -This function returns a formatted string containing the legend for the -chart. The legend describes the symbols used to represent grades for -problems. +=item &html_initialize($r) + +Create labels for the columns of student data to show. + +=item &html_outputstudent($r,$student) + +Return a line of the chart for a student. + +=item &html_finish($r) =cut -sub CreateLegend { - my $Str = "

".
-              "1..9: correct by student in 1..9 tries\n".
-              "   *: correct by student in more than 9 tries\n".
-	      "   +: correct by override\n".
-              "   -: incorrect by override\n".
-	      "   .: incorrect attempted\n".
-	      "   #: ungraded attempted\n".
-              "    : not attempted\n".
-	      "   x: excused".
-              "

"; - return $Str; +####################################################### +####################################################### +{ + my $padding; + my $count; + +sub html_initialize { + my ($r) = @_; + # + $padding = ' 'x3; + $count = 0; + # + my $Str = "

\n";
+    # First, the @StudentData fields need to be listed
+    my @to_show = &get_student_fields_to_show();
+    foreach my $field (@to_show) {
+        my $title=$Apache::lonstatistics::StudentData{$field}->{'title'};
+        my $base =$Apache::lonstatistics::StudentData{$field}->{'base_width'};
+        my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    # Now the selected sequences need to be listed
+    foreach my $sequence (&get_sequences_to_show) {
+        my $title = $sequence->{'title'};
+        my $base  = $sequence->{'base_width'};
+        my $width = $sequence->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    $Str .= "total (of shown problems)
\n"; + $Str .= "
";
+    $r->print($Str);
+    $r->rflush();
+    return;
 }
 
+sub html_outputstudent {
+    my ($r,$student) = @_;
+    my $Str = '';
+    #
+    if($count++ % 5 == 0 && $count > 0) {
+        $r->print("
");
+    }
+    # First, the @StudentData fields need to be listed
+    my @to_show = &get_student_fields_to_show();
+    foreach my $field (@to_show) {
+        my $title=$student->{$field};
+        my $base = length($title);
+        my $width=$Apache::lonstatistics::StudentData{$field}->{'width'};
+        $Str .= $title.' 'x($width-$base).$padding;
+    }
+    # Get ALL the students data
+    my %StudentsData;
+    my @tmp = &Apache::loncoursedata::get_current_state
+        ($student->{'username'},$student->{'domain'},undef,
+         $ENV{'request.course.id'});
+    if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) {
+        %StudentsData = @tmp;
+    }
+    if (scalar(@tmp) < 1) {
+        $Str .= 'No Course Data'."\n";
+        $r->print($Str);
+        $r->rflush();
+        return;
+    }
+    #
+    # By sequence build up the data
+    my $studentstats;
+    my $PerformanceStr = '';
+    foreach my $seq (&get_sequences_to_show) {
+        my ($performance,$score,$seq_max) =
+            &StudentPerformanceOnSequence($student,\%StudentsData,
+                                          $seq,$show_links);
+        my $ratio = $score.'/'.$seq_max;
+        #
+        if ($show eq 'totals') {
+            $performance = ' 'x(length($seq_max)-length($score)).$ratio;
+            $performance .= ' 'x($seq->{'width'}-length($performance));
+        } elsif ($show eq 'scores') {
+            $performance = $score;
+            $performance .= ' 'x($seq->{'width'}-length($performance));
+        } else {
+            # Pad with extra spaces
+            $performance .= ' 'x($seq->{'width'}-$seq_max-
+                                 length($ratio)
+                                 ).$ratio;
+        }
+        #
+        $Str .= $performance.$padding;
+        #
+        $studentstats->{$seq->{'symb'}}->{'score'}= $score;
+        $studentstats->{$seq->{'symb'}}->{'max'}  = $seq_max;
+    }
+    #
+    # Total it up and store the statistics info.
+    my ($score,$max) = (0,0);
+    while (my ($symb,$seq_stats) = each (%{$studentstats})) {
+        $Statistics->{$symb}->{'score'} += $seq_stats->{'score'};
+        $Statistics->{$symb}->{'max'}   += $seq_stats->{'max'};
+        $score += $seq_stats->{'score'};
+        $max   += $seq_stats->{'max'};
+    }
+    $Str .= ' '.' 'x(length($max)-length($score)).$score.'/'.$max;
+    $Str .= " \n";
+    $r->print($Str);
+    #
+    $r->rflush();
+    return;
+}    
+
+sub html_finish {
+    my ($r) = @_;
+    $r->print("
\n"); + $r->rflush(); + return; +} + +} + +####################################################### +####################################################### + =pod -=item &CreateColumnSelectionBox() +=head2 Multi-Sheet EXCEL subroutines -If there are columns not being displayed then this selection box is created -with a list of those columns. When selections are made and the page -refreshed, the columns will be removed from this box and the column is -put back in the chart. If there is no columns to select, no row is added -to the interface table. +=item &multi_sheet_excel_initialize($r) -=over 4 -Input: $CacheData, $headings +=item &multi_sheet_excel_outputstudent($r,$student) +=item &multi_sheet_excel_finish($r) -$CacheData: A pointer to a hash tied to the cached data +=cut -$headings: An array of the names of the columns for the student information. -They are used for displaying which columns are missing. +####################################################### +####################################################### +{ + +sub multi_sheet_excel_initialize { + my ($r)=@_; + $r->print("

Not yet implemented

"); + # + # Estimate the size of the file. We would like to have < 5 megs of data. + my $max_size = 5000000; + my $num_students = scalar(@Apache::lonstatistics::Students); + my $num_sequences = 0; + my $num_data_per_part = 2; # 'status' and 'numtries' + my $fields_per_student = scalar(&get_student_fields_to_show()); + my $bytes_per_field = 20; # Back of the envelope calculation + foreach my $seq (&get_sequences_to_show) { + $num_sequences++ if ($seq->{'num_assess'} > 0); + $fields_per_student += $num_data_per_part * $seq->{'num_assess_parts'}; + } + my $size_estimate = $fields_per_student*$num_students*$bytes_per_field; + # + # Compute number of workbooks + my $num_workbooks = 1; + if ($size_estimate > $max_size) { # try to stay under 5 megs + $num_workbooks += int($size_estimate / $max_size); + } + if ($show eq 'by section') { + if (@Apache::lonstatistics::SelectedSections > 1 && + $Apache::lonstatistics::SelectedSections[0] ne 'all') { + $num_workbooks = scalar(@Apache::lonstatistics::SelectedSections); + } else { + # @Apache::lonstatistics::Sections contains 'all' as well. + $num_workbooks = scalar(@Apache::lonstatistics::Sections) - 1; + } + } + + $r->print("Maximum allowed size: ".$max_size." bytes
"); + $r->print("Number of students: ".$num_students."
"); + $r->print("Number of fields per student: ".$fields_per_student."
"); + $r->print("Total number of fields: ".($fields_per_student*$num_students). + "
"); + $r->print("Bytes per field: ".$bytes_per_field." (estimated)"."
"); + $r->print("Estimated size: ".$size_estimate." bytes
"); + $r->print("Number of workbooks: ".$num_workbooks."
"); + $r->rflush(); + return; +} -Output: $notThere +sub multi_sheet_excel_outputstudent { + my ($r,$student) = @_; +} -$notThere: The string contains one row of a table. The first column has the -name of the selection box. The second contains the selection box -which has a size of four. +sub multi_sheet_excel_finish { + my ($r) = @_; +} -=back +} +####################################################### +####################################################### -=cut +=pod + +=head2 EXCEL subroutines -sub CreateColumnSelectionBox { - my ($CacheData,$headings)=@_; +=item &excel_initialize($r) - my $missing=0; - my $notThere='Select column to view:'; - my $name; - $notThere .= ''; - $notThere .= ''; + # + # Bookkeeping + if ($show eq 'totals') { + $rows_output += 2; } else { - $notThere=''; + $rows_output += 1; + } + # + # Let the user know what we are doing + my $studentcount = scalar(@Apache::lonstatistics::Students); + $r->print("

Compiling Excel spreadsheet for ". + $studentcount.' student'); + $r->print('s') if ($studentcount > 1); + $r->print("

\n"); + $r->rflush(); + # + # Initialize progress window + %prog_state=&Apache::lonhtmlcommon::Create_PrgWin + ($r,'Excel File Compilation Status', + 'Excel File Compilation Progress', $studentcount); + # + return; +} + +sub excel_outputstudent { + my ($r,$student) = @_; + return if (! defined($excel_sheet)); + $cols_output=0; + # + # Write out student data + my @to_show = &get_student_fields_to_show(); + foreach my $field (@to_show) { + $excel_sheet->write($rows_output,$cols_output++,$student->{$field}); + } + # + # Get student assessment data + my %StudentsData; + my @tmp = &Apache::loncoursedata::get_current_state($student->{'username'}, + $student->{'domain'}, + undef, + $ENV{'request.course.id'}); + if ((scalar @tmp > 0) && ($tmp[0] !~ /^error:/)) { + %StudentsData = @tmp; } + # + # Write out sequence scores and totals data + foreach my $seq (&get_sequences_to_show) { + my ($performance,$score,$seq_max) = + &StudentPerformanceOnSequence($student,\%StudentsData, + $seq,'no'); + if ($show eq 'totals' || $show eq 'scores') { + $excel_sheet->write($rows_output,$cols_output++,$score); + } + if ($show eq 'totals') { + $excel_sheet->write($rows_output,$cols_output++,$seq_max); + } + } + # + # Bookkeeping + $rows_output++; + $cols_output=0; + # + # Update the progress window + &Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,'last student'); + return; +} + +sub excel_finish { + my ($r) = @_; + return if (! defined($excel_sheet)); + # + # Write the excel file + $excel_workbook->close(); + my $c = $r->connection(); + # + return if($c->aborted()); + # + # Close the progress window + &Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state); + # + # Tell the user where to get their excel file + $r->print('
'. + 'Your Excel spreadsheet.'."\n"); + $r->rflush(); + return; +} - return $notThere.''; } +####################################################### +####################################################### =pod -=item &CreateColumnSelectors() +=head2 CSV output routines -This function generates the checkboxes above the column headings. The -column will be removed if the checkbox is unchecked. +=item &csv_initialize($r) -=over 4 +=item &csv_outputstudent($r,$student) -Input: $CacheData, $headings +=item &csv_finish($r) -$CacheData: A pointer to a hash tied to the cached data +=cut -$headings: An array of the names of the columns for the student -information. They are used to know what are the student information columns +####################################################### +####################################################### +{ + +sub csv_initialize{ + my ($r) = @_; + $r->print("

Not implemented yet

"); + return; +} -Output: $present +sub csv_outputstudent { + my ($r,$student) = @_; +} -$present: The string contains the first row of a table. Each column contains -a checkbox which is left justified. Currently left justification is used -for consistency of location over the column in which it presides. +sub csv_finish { + my ($r) = @_; +} -=back +} -=cut +####################################################### +####################################################### -sub CreateColumnSelectors { - my ($headings)=@_; =pod - my $found=0; - my ($name, $length, $position); - my $present = ''; - for(my $index=0; $index<(scalar @$headings); $index++) { - $present .= ''; - $present .= ''; - $present .= ''; - $found++; - } +=item &StudentPerformanceOnSequence() - foreach my $sequence (split(/\:/,$CacheData->{'orderedSequences'})) { - if(!&ShouldShowColumn($CacheData, 'ChartSequence'.$sequence)) { - next; - } - $present .= ''; - $present .= ''; - $present .= ''; - $found++; - } +Inputs: - if(!$found) { - $present = ''; - } +=over 4 - return $present.''."\n";; -=cut -} +=item $student -#---- END Student Assessment Web Page ---------------------------------------- +=item $studentdata Hash ref to all student data -#---- Student Assessment Worker Functions ------------------------------------ +=item $seq Hash ref, the sequence we are working on -sub FindSelectedStudent { - my($cache, $selectedName, $students)=@_; +=item $links if defined we will output links to each resource. - if($selectedName eq 'All Students' || - $selectedName eq 'No Student Selected') { - return $selectedName; - } +=back - for(my $index=0; $index<(scalar @$students); $index++) { - my $fullname = $cache->{$students->[$index].':fullname'}; - if($fullname eq $selectedName) { - if($cache->{'StudentAssessmentMove'} eq 'next') { - if($index == ((scalar @$students) - 1)) { - $selectedName = $students->[0]; - return $selectedName; +=cut + +####################################################### +####################################################### +sub StudentPerformanceOnSequence { + my ($student,$studentdata,$seq,$links) = @_; + $links = 'no' if (! defined($links)); + my $Str = ''; + my ($sum,$max) = (0,0); + foreach my $resource (@{$seq->{'contents'}}) { + next if ($resource->{'type'} ne 'assessment'); + my $resource_data = $studentdata->{$resource->{'symb'}}; + my $value = ''; + foreach my $partnum (@{$resource->{'parts'}}) { + $max++; + my $symbol = ' '; # default to space + # + if (exists($resource_data->{'resource.'.$partnum.'.solved'})) { + my $status = $resource_data->{'resource.'.$partnum.'.solved'}; + if ($status eq 'correct_by_override') { + $symbol = '+'; + $sum++; + } elsif ($status eq 'incorrect_by_override') { + $symbol = '-'; + } elsif ($status eq 'ungraded_attempted') { + $symbol = '#'; + } elsif ($status eq 'incorrect_attempted') { + $symbol = '.'; + } elsif ($status eq 'excused') { + $symbol = 'x'; + $max--; + } elsif ($status eq 'correct_by_student' && + exists($resource_data->{'resource.'.$partnum.'.tries'})){ + my $num = $resource_data->{'resource.'.$partnum.'.tries'}; + if ($num > 9) { + $symbol = '*'; + } elsif ($num > 0) { + $symbol = $num; + } else { + $symbol = ' '; + } + $sum++; } else { - $selectedName = $students->[$index+1]; - return $selectedName; + $symbol = ' '; } - } elsif($cache->{'StudentAssessmentMove'} eq 'previous') { - if($index == 0) { - $selectedName = $students->[-1]; - return $selectedName; + } else { + # Unsolved. Did they try? + if (exists($resource_data->{'resource.'.$partnum.'.tries'})){ + $symbol = '.'; } else { - $selectedName = $students->[$index-1]; - return $selectedName; + $symbol = ' '; } - } else { - $selectedName = $students->[$index]; - return $selectedName; } - last; + # + if ($links eq 'yes' && $symbol ne ' ') { + $symbol = ''.$symbol.''; + } + $value .= $symbol; } + $Str .= $value; } - - return 'No Student Selected'; + return ($Str,$sum,$max); } -=pod - -=item &ShouldShowColumn() +####################################################### +####################################################### +sub StudentAverageTotal { + my ($cache, $students, $sequenceKeys)=@_; + my $Str = "\nSummary Tables:\n"; + my %Correct = (); + my $ProblemsSolved = 0; + my $TotalProblems = 0; + my $StudentCount = 0; + + foreach my $name (@$students) { + $StudentCount++; + foreach my $sequence (@$sequenceKeys) { + $Correct{$sequence} += + $cache->{$name.':'.$sequence.':problemsCorrect'}; + } + $ProblemsSolved += $cache->{$name.':problemsSolved'}; + $TotalProblems += $cache->{$name.':totalProblems'}; + } + if ($StudentCount) { + $ProblemsSolved = sprintf( "%.2f", + $ProblemsSolved/$StudentCount); + $TotalProblems /= $StudentCount; + } else { + $ProblemsSolved = 0; + $TotalProblems = 0; + } -Determine if a specified column should be shown on the chart. + $Str .= ''."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; + $Str .= ''."\n"; + $Str .= '
Students Count'. + $StudentCount.'
Total Problems'. + $TotalProblems.'
Average Correct'. + $ProblemsSolved.'
'."\n"; + + $Str .= ''."\n"; + $Str .= ''. + ''."\n"; + foreach my $S(@$sequenceKeys) { + my $title=$cache->{$S.':title'}; + #$Str .= $cache->{$S.':problems'}; + #my @problems=split(':', $cache->{$S.':problems'}); + #my $pCount=scalar @problems; + my $pCount=MaxSeqPr($cache,@$students[0],$S); + my $crr; + if ($StudentCount) { + $crr=sprintf( "%.2f", $Correct{$S}/$StudentCount ); + } else { + $crr="0.00"; + } + $Str .= ''."\n"; + } -=over 4 + $Str .= '
TitleTotal ProblemsAverage Correct
'.$title. + ''.$pCount. + ''.$crr. + '
'."\n"; -Input: $cache, $test + return $Str; +} -$cache: A pointer to the hash tied to the cached data +####################################################### +####################################################### -$test: The form name of the column (heading.$headingIndex) or -(sequence.$sequenceIndex) +=pod -Output: 0 (false), 1 (true) +=item &CreateLegend() -=back +This function returns a formatted string containing the legend for the +chart. The legend describes the symbols used to represent grades for +problems. =cut -sub ShouldShowColumns { - my ($cache,$headings,$cacheKey)=@_; - - my @infoKeys=(); - my @infoHeadings=(); - - my @sequenceKeys=(); - my @sequenceHeadings=(); +####################################################### +####################################################### +sub CreateLegend { + my $Str = "

".
+              "   1  correct by student in 1 try\n".
+              "   7  correct by student in 7 tries\n".
+              "   *  correct by student in more than 9 tries\n".
+	      "   +  correct by hand grading or override\n".
+              "   -  incorrect by override\n".
+	      "   .  incorrect attempted\n".
+	      "   #  ungraded attempted\n".
+              "      not attempted (blank field)\n".
+	      "   x  excused".
+              "

"; + return $Str; +} - my $index; - for($index=0; $index < scalar @$headings; $index++) { - push(@infoHeadings, $headings->[$index]); - push(@infoKeys, $cacheKey->[$index]); - } +####################################################### +####################################################### - foreach my $sequence (split(/\:/,$cache->{'orderedSequences'})) { - push(@sequenceHeadings, $cache->{$sequence.':title'}); - push(@sequenceKeys, $sequence); - } +=pod -# my $headings=$cache->{'form.ChartHeadings'}; -# my $sequences=$cache->{'form.ChartSequences'}; -# if($headings eq 'ALLHEADINGS' || $sequences eq 'ALLSEQUENCES' || -# $headings=~/$test/ || $sequences=~/$test/) { -# return 1; -# } +=back - return (\@infoHeadings, \@infoKeys, \@sequenceHeadings, - \@sequenceKeys); -} +=cut -#---- END Student Assessment Worker Functions -------------------------------- +####################################################### +####################################################### 1; + __END__