# The LearningOnline Network with CAPA
#
# $Id: lonproblemstatistics.pm,v 1.51 2003/06/02 13:58:43 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
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#
# (Navigate problems for statistical reports
#
###############################################
###############################################
=pod
=head1 NAME
lonproblemstatistics
=head1 SYNOPSIS
Routines to present problem statistics to instructors via tables,
Excel files, and plots.
=over 4
=cut
###############################################
###############################################
package Apache::lonproblemstatistics;
use strict;
use Apache::lonnet();
use Apache::lonhtmlcommon;
use Apache::loncoursedata;
use Apache::lonstatistics;
use Spreadsheet::WriteExcel;
my @Fields = (
{ name => 'problem_num',
title => 'P#',
align => 'right',
color => '#FFFFE6' },
{ name => 'container',
title => 'Sequence or Folder',
align => 'left',
color => '#FFFFE6',
sortable => 'yes' },
{ name => 'title',
title => 'Title',
align => 'left',
color => '#FFFFE6',
special => 'link',
sortable => 'yes', },
{ name => 'part',
title => 'Part',
align => 'left',
color => '#FFFFE6' },
{ name => 'num_students',
title => '#Stdnts',
align => 'right',
color => '#EEFFCC',
format => '%d',
sortable => 'yes',
graphable => 'yes',
long_title => 'Number of Students Attempting Problem' },
{ name => 'tries',
title => 'Tries',
align => 'right',
color => '#EEFFCC',
format => '%d',
sortable => 'yes',
graphable => 'yes',
long_title => 'Total Number of Tries' },
{ name => 'max_tries',
title => 'Max Tries',
align => 'right',
color => '#DDFFFF',
format => '%d',
sortable => 'yes',
graphable => 'yes',
long_title => 'Maximum Number of Tries' },
{ name => 'mean_tries',
title => 'Mean Tries',
align => 'right',
color => '#DDFFFF',
format => '%5.2f',
sortable => 'yes',
graphable => 'yes',
long_title => 'Average Number of Tries' },
{ name => 'std_tries',
title => 'S.D. tries',
align => 'right',
color => '#DDFFFF',
format => '%5.2f',
sortable => 'yes',
graphable => 'yes',
long_title => 'Standard Deviation of Number of Tries' },
{ name => 'skew_tries',
title => 'Skew Tries',
align => 'right',
color => '#DDFFFF',
format => '%5.2f',
sortable => 'yes',
graphable => 'yes',
long_title => 'Skew of Number of Tries' },
{ name => 'deg_of_diff',
title => 'DoDiff',
align => 'right',
color => '#DDFFFF',
format => '%5.2f',
sortable => 'yes',
graphable => 'yes',
long_title => 'Degree of Difficulty' },
{ name => 'num_solved',
title => '#YES',
align => 'right',
color => '#FFDDDD',
format => '%d',
sortable => 'yes',
graphable => 'yes',
long_title => 'Number of Students able to Solve' },
{ name => 'num_override',
title => '#yes',
align => 'right',
color => '#FFDDDD',
format => '%d',
sortable => 'yes',
graphable => 'yes',
long_title => 'Number of Students given Override' },
{ name => 'per_wrong',
title => '%Wrng',
align => 'right',
color => '#FFFFE6',
format => '%4.1f',
sortable => 'yes',
graphable => 'yes',
long_title => 'Percent Wrong' },
);
###############################################
###############################################
=pod
=item &CreateInterface()
Create the main intereface for the statistics page. Allows the user to
select sections, maps, and output.
=cut
###############################################
###############################################
sub CreateInterface {
my $Str = '';
$Str .= '
'."\n";
return $Str;
}
#######################################################
#######################################################
=pod
=item &CreateAndParseOutputSelector()
Construct a selection list of options for output and parse output selections.
The current output selected is indicated by the values of the two package
variables $output_mode and $show. @OutputOptions holds the descriptions of
the output options and the values for $output_mode and $show.
Based on code from lonstudentassessment.pm.
=cut
#######################################################
#######################################################
my $output_mode;
my $show;
my @OutputOptions =
(
{ name => 'problem statistics grouped by sequence',
value => 'HTML problem statistics grouped',
description => 'Output statistics for the problem parts.',
mode => 'html',
show => 'grouped',
},
{ name => 'problem statistics ungrouped',
value => 'HTML problem statistics ungrouped',
description => 'Output statistics for the problem parts.',
mode => 'html',
show => 'ungrouped',
},
{ name => 'problem statistics, Excel',
value => 'Excel problem statistics',
description => 'Output statistics for the problem parts '.
'in an Excel workbook',
mode => 'excel',
show => 'all',
},
);
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 = 'statsoutputmode';
#
# Format for output options is 'mode, restrictions';
my $selected = 'HTML problem statistics grouped';
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
$output_mode = 'html';
$show = 'all';
foreach my $option (@OutputOptions) {
next if ($option->{'value'} ne $selected);
$output_mode = $option->{'mode'};
$show = $option->{'show'};
}
#
# Build the form element
$Str = qq/";
return $Str;
}
###############################################
###############################################
=pod
=item &Gather_Student_Data()
Ensures all student data is up to date.
=cut
###############################################
###############################################
sub Gather_Student_Data {
my ($r) = @_;
my $c = $r->connection();
#
my @Sequences = &Apache::lonstatistics::Sequences_with_Assess();
#
my @Students = @Apache::lonstatistics::Students;
#
# Open the progress window
my %prog_state=&Apache::lonhtmlcommon::Create_PrgWin
($r,'Statistics Compilation Status',
'Statistics Compilation Progress', scalar(@Students));
#
while (my $student = shift @Students) {
return if ($c->aborted());
my ($status,undef) = &Apache::loncoursedata::ensure_current_data
($student->{'username'},$student->{'domain'},
$ENV{'request.course.id'});
&Apache::lonhtmlcommon::Increment_PrgWin($r,\%prog_state,
'last student');
}
&Apache::lonhtmlcommon::Close_PrgWin($r,\%prog_state);
$r->rflush();
}
###############################################
###############################################
=pod
=item &BuildProblemStatisticsPage()
Main interface to problem statistics.
=cut
###############################################
###############################################
sub BuildProblemStatisticsPage {
my ($r,$c)=@_;
#
$output_mode = 'html';
$show = 'grouped';
#
$r->print(&CreateInterface());
$r->print('');
$r->print('');
$r->print('');
if (! exists($ENV{'form.statsfirstcall'})) {
$r->print(<
Please make your selections in the boxes above and hit
the button marked "Update Display".
ENDMSG
return;
}
#
&Gather_Student_Data($r);
#
#
if ($output_mode eq 'html') {
$r->print("
");
}
return;
}
###############################################
###############################################
=pod
=item &output_html_grouped_by_sequence()
Presents the statistics data as an html table organized by the order
the assessments appear in the course.
=cut
###############################################
###############################################
sub output_html_grouped_by_sequence {
my ($r) = @_;
my $problem_num = 0;
#$r->print(&ProblemStatisticsLegend());
foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()) {
next if ($sequence->{'num_assess'}<1);
$r->print("
".$sequence->{'title'}."
");
$r->print('
'."\n");
$r->print('
'."\n");
$r->print('
');
my $Str = &statistics_table_header('no container no plots');
$r->print('
'.$Str."
\n");
foreach my $resource (@{$sequence->{'contents'}}) {
next if ($resource->{'type'} ne 'assessment');
foreach my $part (@{$resource->{'parts'}}) {
$problem_num++;
my $data = &get_statistics($sequence,$resource,$part,
$problem_num);
my $option = '';
$r->print('
\n");
$r->rflush();
}
#
return;
}
###############################################
###############################################
=pod
=item &output_html_ungrouped()
Presents the statistics data in a single html table which can be sorted by
different columns.
=cut
###############################################
###############################################
sub output_html_ungrouped {
my ($r,$option) = @_;
#
if (exists($ENV{'form.plot'}) && $ENV{'form.plot'} ne '') {
&plot_statistics($r,$ENV{'form.plot'});
}
#
my $problem_num = 0;
my $show_container = 0;
my $show_part = 0;
#$r->print(&ProblemStatisticsLegend());
my $sortby = undef;
foreach my $field (@Fields) {
if ($ENV{'form.sortby'} eq $field->{'name'}) {
$sortby = $field->{'name'};
}
}
if (! defined($sortby) || $sortby eq '' || $sortby eq 'problem_num') {
$sortby = 'container';
}
# If there is more than one sequence, list their titles
my @Sequences = &Apache::lonstatistics::Sequences_with_Assess();
if (@Sequences < 1) {
$option .= ' no container';
}
#
# Compile the data
my @Statsarray;
foreach my $sequence (@Sequences) {
next if ($sequence->{'num_assess'}<1);
foreach my $resource (@{$sequence->{'contents'}}) {
next if ($resource->{'type'} ne 'assessment');
foreach my $part (@{$resource->{'parts'}}) {
$problem_num++;
my $data = &get_statistics($sequence,$resource,$part,
$problem_num);
$show_part = 1 if ($part ne '0');
#
push (@Statsarray,$data);
}
}
}
#
# Sort the data
my @OutputOrder;
if ($sortby eq 'container') {
@OutputOrder = @Statsarray;
} else {
# $sortby is already defined, so we can charge ahead
if ($sortby =~ /^(title|part)$/i) {
# Alpha comparison
@OutputOrder = sort {
lc($a->{$sortby}) cmp lc($b->{$sortby}) ||
lc($a->{'title'}) cmp lc($b->{'title'}) ||
lc($a->{'part'}) cmp lc($b->{'part'});
} @Statsarray;
} else {
# Numerical comparison
@OutputOrder = sort {
my $retvalue = 0;
if ($b->{$sortby} eq 'nan') {
if ($a->{$sortby} ne 'nan') {
$retvalue = -1;
} else {
$retvalue = 0;
}
}
if ($a->{$sortby} eq 'nan') {
if ($b->{$sortby} ne 'nan') {
$retvalue = 1;
}
}
if ($retvalue eq '0') {
$retvalue = $b->{$sortby} <=> $a->{$sortby} ||
lc($a->{'title'}) <=> lc($b->{'title'}) ||
lc($a->{'part'}) <=> lc($b->{'part'});
}
$retvalue;
} @Statsarray;
}
}
$option .= 'no part' if (! $show_part);
my $num_output = 0;
#
# output the headers
$r->print('
'."\n");
$r->print('
'."\n");
my $Str = &statistics_table_header($option.' sortable');
$r->print('
'.$Str."
\n");
#
foreach my $rowdata (@OutputOrder) {
$num_output++;
if ($num_output % 25 == 0) {
$r->print("
\n
\n");
#
$r->print('
'."\n");
$r->print('
'."\n");
my $Str = &statistics_table_header($option.' sortable');
$r->print('
\n");
$r->rflush();
#
return;
}
###############################################
###############################################
=pod
=item &output_excel()
Presents the statistical data in an Excel 95 compatable spreadsheet file.
=cut
###############################################
###############################################
sub output_excel {
my ($r) = @_;
my $filename = '/prtspool/'.
$ENV{'user.name'}.'_'.$ENV{'user.domain'}.'_'.
time.'_'.rand(1000000000).'.xls';
#
my $excel_workbook = undef;
my $excel_sheet = undef;
#
my $rows_output = 0;
my $cols_output = 0;
#
# Create sheet
$excel_workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
#
# Check for errors
if (! defined($excel_workbook)) {
$r->log_error("Error creating excel spreadsheet $filename: $!");
$r->print("Problems creating new Excel file. ".
"This error has been logged. ".
"Please alert your LON-CAPA administrator");
return ;
}
#
# The excel spreadsheet stores temporary data in files, then put them
# together. If needed we should be able to disable this (memory only).
# The temporary directory must be specified before calling 'addworksheet'.
# File::Temp is used to determine the temporary directory.
$excel_workbook->set_tempdir($Apache::lonnet::tmpdir);
#
# Add a worksheet
my $sheetname = $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
if (length($sheetname) > 31) {
$sheetname = substr($sheetname,0,31);
}
$excel_sheet = $excel_workbook->addworksheet($sheetname);
#
# Put the course description in the header
$excel_sheet->write($rows_output,$cols_output++,
$ENV{'course.'.$ENV{'request.course.id'}.'.description'});
$cols_output += 3;
#
# Put a description of the sections listed
my $sectionstring = '';
my @Sections = @Apache::lonstatistics::SelectedSections;
if (scalar(@Sections) > 1) {
if (scalar(@Sections) > 2) {
my $last = pop(@Sections);
$sectionstring = "Sections ".join(', ',@Sections).', and '.$last;
} else {
$sectionstring = "Sections ".join(' and ',@Sections);
}
} else {
if ($Sections[0] eq 'all') {
$sectionstring = "All sections";
} else {
$sectionstring = "Section ".$Sections[0];
}
}
$excel_sheet->write($rows_output,$cols_output++,$sectionstring);
$cols_output += scalar(@Sections);
#
# Put the date in there too
$excel_sheet->write($rows_output,$cols_output++,
'Compiled on '.localtime(time));
#
$rows_output++;
$cols_output=0;
#
# Add the headers
foreach my $field (@Fields) {
next if ($field->{'name'} eq 'problem_num');
$excel_sheet->write($rows_output,$cols_output++,$field->{'title'});
}
$rows_output++;
#
# Write the data
my $problem_num=0;
foreach my $sequence (&Apache::lonstatistics::Sequences_with_Assess()) {
next if ($sequence->{'num_assess'}<1);
foreach my $resource (@{$sequence->{'contents'}}) {
next if ($resource->{'type'} ne 'assessment');
foreach my $part (@{$resource->{'parts'}}) {
$cols_output=0;
$problem_num++;
my $data = &get_statistics($sequence,$resource,$part,
$problem_num);
#
if (!defined($part) || $part eq '') {
$part = ' ';
}
foreach my $field (@Fields) {
next if ($field->{'name'} eq 'problem_num');
$excel_sheet->write($rows_output,$cols_output++,
$data->{$field->{'name'}});
}
$rows_output++;
}
}
}
#
# Write the excel file
$excel_workbook->close();
# Tell the user where to get their excel file
$r->print(' '.
'Your Excel spreadsheet.'."\n");
$r->rflush();
return;
}
###############################################
###############################################
=pod
=item &statistics_html_table_data()
Help function used to format the rows for HTML table output.
=cut
###############################################
###############################################
sub statistics_html_table_data {
my ($data,$options) = @_;
my $row = '';
foreach my $field (@Fields) {
next if ($options =~ /no $field->{'name'}/);
$row .= '
';
}
return $row;
}
sub statistics_table_header {
my ($options) = @_;
my $header_row;
foreach my $field (@Fields) {
next if ($options =~ /no $field->{'name'}/);
$header_row .= '
\n");
#
# Print out the data
$ENV{'form.sortby'} = 'Contents';
# &output_html_ungrouped($r);
return;
}
###############################################
###############################################
=pod
=item &DrawGraph()
=cut
###############################################
###############################################
sub DrawGraph {
my ($values,$title,$xaxis,$yaxis,$Max)=@_;
$title = '' if (! defined($title));
$xaxis = '' if (! defined($xaxis));
$yaxis = '' if (! defined($yaxis));
#
my $sendValues = join(',', @$values);
my $sendCount = scalar(@$values);
$Max =1 if ($Max < 1);
if ( int($Max) < $Max ) {
$Max++;
$Max = int($Max);
}
my @GData = ($title,$xaxis,$yaxis,$Max,$sendCount,$sendValues);
return '';
}
sub get_statistics {
my ($sequence,$resource,$part,$problem_num) = @_;
#
my $symb = $resource->{'symb'};
my $courseid = $ENV{'request.course.id'};
#
my $students = \@Apache::lonstatistics::Students;
if ($Apache::lonstatistics::SelectedSections[0] eq 'all') {
$students = undef;
}
my $data = &Apache::loncoursedata::get_problem_statistics
($students,$symb,$part,$courseid);
$data->{'part'} = $part;
$data->{'problem_num'} = $problem_num;
$data->{'container'} = $sequence->{'title'};
$data->{'title'} = $resource->{'title'};
$data->{'title.link'} = $resource->{'src'};
#
return $data;
}
###############################################
###############################################
=pod
=item &ProblemStatisticsLegend()
=cut
###############################################
###############################################
sub ProblemStatisticsLegend {
my $Ptr = '';
$Ptr = '
';
$Ptr .= '
';
$Ptr .= '#Stdnts
';
$Ptr .= '
Total number of students attempted the problem.';
$Ptr .= '
';
$Ptr .= 'Tries
';
$Ptr .= '
Total number of tries for solving the problem.';
$Ptr .= '
';
$Ptr .= 'Max Tries
';
$Ptr .= '
Largest number of tries for solving the problem by a student.';
$Ptr .= '
';
$Ptr .= 'Mean
';
$Ptr .= '
Average number of tries. [ Tries / #Stdnts ]';
$Ptr .= '
';
$Ptr .= '#YES
';
$Ptr .= '
Number of students solved the problem correctly.';
$Ptr .= '
';
$Ptr .= '#yes
';
$Ptr .= '
Number of students solved the problem by override.';
$Ptr .= '
';
$Ptr .= '%Wrong
';
$Ptr .= '
Percentage of students who tried to solve the problem ';
$Ptr .= 'but is still incorrect. [ 100*((#Stdnts-(#YES+#yes))/#Stdnts) ]';
$Ptr .= '
';
$Ptr .= 'DoDiff
';
$Ptr .= '
Degree of Difficulty of the problem. ';
$Ptr .= '[ 1 - ((#YES+#yes) / Tries) ]';
$Ptr .= '
';
$Ptr .= 'S.D.
';
$Ptr .= '
Standard Deviation of the tries. ';
$Ptr .= '[ sqrt(sum((Xi - Mean)^2)) / (#Stdnts-1) ';
$Ptr .= 'where Xi denotes every student\'s tries ]';
$Ptr .= '
';
$Ptr .= 'Skew.
';
$Ptr .= '
Skewness of the students tries.';
$Ptr .= '[(sqrt( sum((Xi - Mean)^3) / #Stdnts)) / (S.D.^3)]';
$Ptr .= '
';
$Ptr .= 'Dis.F.
';
$Ptr .= '
Discrimination Factor: A Standard for evaluating the ';
$Ptr .= 'problem according to a Criterion ';
$Ptr .= '[Criterion to group students into %27 Upper Students - ';
$Ptr .= 'and %27 Lower Students] ';
$Ptr .= '1st Criterion for Sorting the Students: ';
$Ptr .= 'Sum of Partial Credit Awarded / Total Number of Tries ';
$Ptr .= '2nd Criterion for Sorting the Students: ';
$Ptr .= 'Total number of Correct Answers / Total Number of Tries';
$Ptr .= '
';
$Ptr .= '
Disc.
';
$Ptr .= '
Number of Students had at least one discussion.';
$Ptr .= '
';
return $Ptr;
}
#---- END Problem Statistics Web Page ----------------------------------------
1;
__END__