Citolab.QTI.ScoringEngine 1.2.3

There is a newer version of this package available.
See the version list below for details.
dotnet add package Citolab.QTI.ScoringEngine --version 1.2.3                
NuGet\Install-Package Citolab.QTI.ScoringEngine -Version 1.2.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Citolab.QTI.ScoringEngine" Version="1.2.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Citolab.QTI.ScoringEngine --version 1.2.3                
#r "nuget: Citolab.QTI.ScoringEngine, 1.2.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Citolab.QTI.ScoringEngine as a Cake Addin
#addin nuget:?package=Citolab.QTI.ScoringEngine&version=1.2.3

// Install Citolab.QTI.ScoringEngine as a Cake Tool
#tool nuget:?package=Citolab.QTI.ScoringEngine&version=1.2.3                

Citolab QTI Scoring Engine

This library can be used for response and outcome scoring. Currenly it supports 2.x and 3.0 packages and v2.x Results Reporting.

It does not support all response and outcome scoring (yet) but all items in section 3.2 Simple Items are scored correctly.

Response processing

Cardinality

Supported:

  • single
  • multiple
  • ordered

BaseType

Supported:

  • directedPair
  • identifier
  • integer
  • float
  • pair
  • point
  • string

Unsupported:

  • Duration,
  • file
  • Uri
  • IntOrIdentifier

Rules

Supported:

  • qti-lookup-outcome-value
  • qti-outcome-condition
  • qti-outcome-else
  • qti-outcome-elseif
  • qti-outcome-if
  • qti-response-if
  • qti-response-elseif
  • qti-response-else
  • qti-response-condition
  • qti-set-outcome-value

Unsupported:

  • qti-exit-response
  • qti-include
  • qti-response-processing-fragment

Expressions:

Supported:

  • qti-and
  • qti-base-value
  • qti-correct
  • qti-custom-operator
  • qti-equal* (toleranceMode: exact only)
  • qti-gt
  • qti-gte
  • qti-isNull
  • qti-equal-rounded
  • qti-lt
  • qti-lte
  • qti-map-response
  • qti-map-response-point
  • qti-match
  • qti-member
  • qti-number-selected
  • qti-number-presented
  • qti-or
  • qti-ordered
  • qti-round
  • qti-string-match
  • qti-substring
  • qti-sum
  • qti-variable

Unsupported:

  • qti-any-n
  • qti-container-size
  • qti-contains
  • qti-default
  • qti-delete
  • qti-divide
  • qti-duration-gte
  • qti-duration-lt
  • qti-field-value
  • qti-gcd
  • qti-lcm
  • qti-number-correct
  • qti-number-incorrect
  • qti-number-responded
  • qti-repeat
  • qti-index
  • qti-inside
  • qti-integer-divide
  • qti-integer-modulus
  • qti-integer-to-float
  • qti-math-operator
  • qti-math-constant
  • qti-max
  • qti-min
  • qti-multiple
  • qti-not
  • qti-null
  • qti-outcome-maximum
  • qti-outcome-minimum
  • qti-pattern-match
  • qti-power
  • qti-product
  • qti-random
  • qti-random-float
  • qti-random-integer
  • qti-round-to
  • qti-stats-operator
  • qti-subtract
  • qti-truncate

Usage

The Scoring Engine implement IScoringEngine which contains 3 functions:

  • ProcessResponses: executes responseProcessing
  • ProcessOutcomes: executes outcomeProcessing
  • ProcessResponsesAndOutcomes: executes both outcomeProcessing and responseProcessing

The provided list of assessmentResults is updated with scoring info. The functions also return this list of assessmentResults.

The provided context contains:

  • List<XDocument> AssessmentmentResults : list of assessmentResults. For responseProcessing ItemResult should at least contain the candidateResponse.
  • ILogger Logger (optional): logs the processing steps as informational and log warnings and errors.

For responseProcessing the context extends the following properties:

  • List<XDocument> AssessmentItems: List of XDocuments with the assessmentItems.
  • Dictionary<string, ICustomOperator> CustomOperators (optional): can be provided to handle customOperators. The definition property of the CustomOperator should map the definition attribute value of the customOperator.
  • bool ProcessParallel: process results parallel. Could gain significant performance with processing lots of assessmentResults at onces.

For outcomeProcessing the context extends the following properties:

  • Document AssessmentTest: A XDocument with the assessmentTest.
public interface IScoringEngine
{
    List<XDocument> ProcessResponses(IResponseProcessingContext ctx);
    List<XDocument> ProcessOutcomes(IOutcomeProcessingContext ctx);
    List<XDocument> ProcessResponsesAndOutcomes(IScoringContext ctx);
}

Example

var qtiScoringEngine = new ScoringEngine();
var scoredAssessmentResults = qtiScoringEngine.ProcessResponsesAndOutcomes(new ScoringContext
{
    AssessmentItems = assessmentItemXDocs,
    AssessmentTest = assessmentTestXDoc,
    AssessmentmentResults = assessmentResultXDocs,
    Logger = _logger
});

Error handling

ScoringEngineException

A ScoringEngineException will be thrown when:

  • Calling responseProcessing without context or not a list of items.
  • Calling outcomeProcessing without context or without an assessmentTest.

Unhandled exceptions

Because some dictionaries are created to be able to do fast lookups some it will break on double identifiers e.g.

  • Same itemRef twice in a test.
  • Multiple itemResults for the same item in an AssessmentResult
  • Multiple outcome-/responseDeclarations with the same identifier in the same AssessmentItem.

Logging

A lot is logged. Some informational to be able to track the prossing but also errors that will not throw an exception and just result in score 0.

E.g.

  • BaseType does not map to actual value. E.g. float = 'hello'
  • Invalid lookup in interpolation, mapResponse etc.

missings

If response processing is called without candidateResponses it will add the outcomeVariables that are used in responseProcessing with the defaultValue if defined, otherwise 0.

All oucomeVariables that are used in the response processing are reset to zero and re-calcuted.

OutcomeVariable that are not used in the response processing. For example if there is an outcomeVariable 'numAttempts' or 'toolsUsed' it won't be touched and will be in the AssessmentResult with the same value.

Processing Packages

The project: Console.ScoringEngine contains an example of how to process assessmentResults for a package.

It can be run in the console:

The first argument should be the path to the package. The second argument should be the folder where the assessmentResults are located.

 dotnet run Console.Scoring "C:\\mypackage.zip" "C:\\assessmentResults

the file/folder settings can also be set from in the appSettings file.

Custom operators

Because customOperators are often specific to delivery eniges they can be provided to this scoring engine.

example:

public class Trim : ICustomOperator
{
   public BaseValue Apply(BaseValue value)
   {
       if (value?.Value != null)
       {
           value.Value = value.Value.Trim();
       }
       return value;
   }
}

CustomOperators = new Dictionary<string, Citolab.QTI.ScoringEngine.Interfaces.ICustomOperator>
{
   {  "decp:Trim", new Trim() }
}

handles:

<customOperator definition="depcp:Trim">
    <variable identifier="RESPONSE"/>
</customOperator>

There are three example implementations in this engine:

  • depcp:Trim|questify:Trim|qade:Trim: Trims the value
  • depcp:ToAscii|questify:ToAscii|questify:qade: Handlers diacritics
  • depcp:ParseCommaDecimal|questify:ParseCommaDecimal|qade:ParseCommaDecimal: Replaces , to .
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.1 247 4/18/2024
1.3.0 718 3/5/2024
1.3.0-beta2 322 2/9/2024
1.3.0-beta1 94 2/9/2024
1.2.5 407 1/24/2024
1.2.4 114 1/23/2024
1.2.3 132 1/18/2024
1.2.2 624 9/14/2023
1.2.1 145 9/8/2023
1.2.0 176 8/3/2023
1.1.1 3,858 9/17/2021
1.1.0 411 8/6/2021
1.0.1 323 8/6/2021
1.0.0 347 6/9/2021
1.0.0-beta.2 190 6/7/2021
1.0.0-beta.1 194 5/31/2021
1.0.0-beta.0 203 5/31/2021