'."\n";
+my $Statistics;
- return $Str;
-}
+#######################################################
+#######################################################
=pod
-=item &FormatStudentData()
+=item $show_links 'yes' or 'no' for linking to student performance data
-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.
+=item $output_mode 'html', 'excel', or 'csv' for output mode
-=over 4
+=item $show 'all', 'totals', or 'scores' determines how much data is output
+
+=cut
+
+#######################################################
+#######################################################
+my $show_links;
+my $output_mode;
+my $show;
+
+#######################################################
+#######################################################
+# End of package variable declarations
+
+=pod
+
+=back
+
+=cut
-Input: $name, $studentInformation, $ChartDB
+#######################################################
+#######################################################
-$name: The name and domain of the current student in name:domain format
+=pod
+
+=item &BuildStudentAssessmentPage()
-$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.
+Inputs:
-$ChartDB: The name of the cached data database which will be tied to that
-database.
+=over 4
-Output: $Str
+=item $r Apache Request
-$Str: Formatted string that is an entire row of the chart. It is a
-concatenation of student information and student course information.
+=item $c Apache Connection
=back
=cut
-sub StudentReport {
- my ($cache,$name,$spacing,$showSequences)=@_;
- my ($username,$domain)=split(':',$name);
-
- my $Str = '';
- if(defined($cache->{$name.':error'})) {
- return $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;
}
- if($cache->{$name.':error'} =~ /course/) {
- $Str .= 'No course data for student ';
- $Str .= ''.$username.'. ';
- return $Str;
- }
-
- foreach my $sequence (@$showSequences) {
- my $characterCount=0;
- foreach my $problemID (split(':', $cache->{$sequence.':problems'})) {
- my $problem = $cache->{$problemID.':problem'};
- # 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
- foreach(split(/\:/,$cache->{$sequence.':'.$problemID.
- ':parts'})) {
- $characterCount++;
- if(defined($cache->{$name.':'.$problemID.':NoVersion'}) ||
- $cache->{$name.':'.$problemID.':'.$_.':code'} eq ' ') {
- $Str .= ' ';
- next;
- }
- $Str .= '';
- my $code = $cache->{$name.':'.$problemID.':'.$_.':code'};
- my $tries = $cache->{$name.':'.$problemID.':'.$_.':tries'};
- if($code eq '*' && $tries < 10 && $tries ne '') {
- $code = $tries;
- }
- $Str .= $code;
- $Str.='';
- }
+ #
+ #
+ 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;
+}
- # 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", $cache->{$name.':'.$sequence.
- ':problemsCorrect'});
- $Str .= ''.$outputProblemsCorrect.'';
- $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", $cache->{$name.':problemsSolved'});
- my $outputTotalProblems = sprintf("%4d", $cache->{$name.':totalProblems'});
- $Str .= ''.$outputProblemsSolved.
- ' / '.$outputTotalProblems.'';
+#######################################################
+#######################################################
- return $Str;
+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;
+}
+
+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;
}
+
+#######################################################
+#######################################################
+
=pod
-=item &CreateLegend()
+=item &CreateInterface()
-This function returns a formatted string containing the legend for the
-chart. The legend describes the symbols used to represent grades for
-problems.
+Called by &BuildStudentAssessmentPage to create the top part of the
+page which displays the chart.
+
+Inputs: None
+
+Returns: A string containing the HTML for the headers and top table for
+the chart page.
=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".
- "
'."\n";
return $Str;
}
+#######################################################
+#######################################################
+
=pod
-=item &CreateColumnSelectionBox()
+=item &CreateAndParseOutputSelector()
-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.
+=cut
-=over 4
-Input: $CacheData, $headings
+#######################################################
+#######################################################
+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;
+}
-$CacheData: A pointer to a hash tied to the cached data
+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'};
+ }
-$headings: An array of the names of the columns for the student information.
-They are used for displaying which columns are missing.
+ #
+ # Build the form element
+ $Str = qq/";
+ return $Str;
+}
-Output: $notThere
+#######################################################
+#######################################################
-$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.
+=pod
-=back
+=head2 HTML output routines
-=cut
+=item &html_initialize($r)
+
+Create labels for the columns of student data to show.
+
+=item &html_outputstudent($r,$student)
-sub CreateColumnSelectionBox {
- my ($doNotShow)=@_;
+Return a line of the chart for a student.
- my $notThere = '';
- $notThere .= '';
+sub html_finish {
+ my ($r) = @_;
+ $r->print("\n");
+ $r->rflush();
+ return;
+}
- return $notThere;
}
+#######################################################
+#######################################################
+
=pod
-=item &CreateColumnSelectors()
+=head2 Multi-Sheet EXCEL subroutines
-This function generates the checkboxes above the column headings. The
-column will be removed if the checkbox is unchecked.
+=item &multi_sheet_excel_initialize($r)
-=over 4
+=item &multi_sheet_excel_outputstudent($r,$student)
+
+=item &multi_sheet_excel_finish($r)
+
+=cut
+
+#######################################################
+#######################################################
+{
+
+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;
+}
-Input: $CacheData, $headings
+sub multi_sheet_excel_outputstudent {
+ my ($r,$student) = @_;
+}
-$CacheData: A pointer to a hash tied to the cached data
+sub multi_sheet_excel_finish {
+ my ($r) = @_;
+}
-$headings: An array of the names of the columns for the student
-information. They are used to know what are the student information columns
+}
+#######################################################
+#######################################################
-Output: $present
+=pod
-$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.
+=head2 EXCEL subroutines
-=back
+=item &excel_initialize($r)
-=cut
+=item &excel_outputstudent($r,$student)
-sub CreateColumnSelectors {
- my ($infoHeadings, $sequenceHeadings, $sequenceKeys)=@_;
+=item &excel_finish($r)
- my $present = '';
- for(my $index=0; $index<(scalar @$infoHeadings); $index++) {
- $present .= '
'."\n";
- return (\@infoHeadings, \@infoKeys, \@sequenceHeadings,
- \@sequenceKeys, \%doNotShow);
+ return $Str;
}
-#---- END Student Assessment Worker Functions --------------------------------
+#######################################################
+#######################################################
+
+=pod
+
+=item &CreateLegend()
+
+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 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".
+ "