Skip to content

Commit

Permalink
chore(docs): update student competency method docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nbey authored and themightychris committed Aug 4, 2021
1 parent 8ee9ef8 commit 7af85b0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/slate-cbl/logic/student-competency-calculations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
| Method Name | Description | Output |
| ----------- | ----------- | ------ |
| getDemonstrationData | Get demonstrations, **grouped** by `SkillID` and **ordered** by `DemonstrationDate` and `DemonstrationID` | Array of demonstrations
| getDemonstrationOpportunities | Equal to the total amount of **non-Override demonstrations** found in `getDemonstrationData` | Array of demonstrations
| getDemonstrationOpportunities | Equal to the total amount of **non-Override demonstrations** found in `getDemonstrationData`. If a demonstration has a **wildcard `EvidenceWehight`**, the result will be equal to the amount of Demonstrations (Evidence) Required. | Total of Demonstration opportunities
| sortDemonstrations | Demonstrations are sorted by their `ID` | Array of demonstrations
| sortEffectiveDemonstrations | Sort demonstrations by `DemonstratedLevel`, or by the `sortDemonstrations` method if the demonstrations have the same `DemonstratedLevel` | Array of demonstrations
| getEffectiveDemonstrationsData | Sort `getDemonstrationData` via `sortEffectiveDemonstrations`. Reduce the number of demonstrations to the amount of *demonstrations required for the respective `Level`*. Sort the demonstrations again via `sortDemonstrations` | Array of demonstrations
| getDemonstrationsLogged | Get demonstrations via `getEffectiveDemonstrationsData`. Exclude **Overrides** and records that do not have a **DemonstratedLevel**. | Total of demonstrations found
| getDemonstrationsLogged | Get demonstrations via `getEffectiveDemonstrationsData`. Exclude **Overrides** and records that do not have a **DemonstratedLevel**. | Sum of `EvidenceWeight` for demonstrations found
| getDemonstrationsMissed | Get demonstrations via `getEffectiveDemonstrationsData`. Exclude **Overrides** and records that have a **DemonstratedLevel** | Total of demonstrations found
| getDemonstrationsComplete | Get demonstrations via `getEffectiveDemonstrationsData`. If `DemonstratedLevel` is set, Increase the total by **1**. If record is an **Override**, Increase the total by the amount of demonstrations required for the respective Skill Level (via `Skill::getDemonstrationsRequiredByLevel()`). If the Demonstration is an **Override**, equal to the the amount of skills required for that demonstration. | Total of demonstrations completed
| getDemonstrationsAverage | Equal to the total of `DemonstratedLevel` for demonstrations via `getEffectiveDemonstrations` that are *not an Override*, **divided** by the amount of demonstrations via `getDemonstrationsLogged`. (*There must be at least one demonstration logged.*) | Average **DemonstratedLevel** for demonstrations
| getDemonstrationsComplete | Get demonstrations via `getEffectiveDemonstrationsData`. If `DemonstratedLevel` is set, Increase the total by the respctive **`EvidenceWeight`**. If record is an **Override**, Increase the total by the amount of demonstrations required for the respective Skill Level (via `Skill::getDemonstrationsRequiredByLevel()`). | Total of demonstrations or demonstrations (Evidence) Required for the respective level.
| getDemonstrationsAverage | Equal to the sum of `DemonstratedLevel` for demonstrations via `getEffectiveDemonstrations` that are *not an Override*, **divided** by the amount of demonstrations via `getDemonstrationsLogged`. (*There must be at least one demonstration logged.*) | Average **DemonstratedLevel** for demonstrations
| getDemonstrationsRequired | Get demonstrations required for the respective **`Competency`** and **`Level`** | Total of demonstrations required
| getMinimumAverage | Get minimum average rating for the respective **Level**. This can be implemented in the following ways. Implementation will vary based on Slate configuration. Either: Hard-coded array of **Levels** mapped to the custom **Minimum Average** OR Hard-coded function that can determine the **Minimum Average** based on the **StudentComptency** OR Hard-coded **Minimum Average** value. | Minimum Average Rating
| getMinimumRating | Get minimum rating for the respective **Level**. This can be implemented in the following ways. Implementation will vary based on Slate configuration. Either: Hard-coded array of **Levels** mapped to the custom **Minimum Rating** OR Hard-coded function that can determine the **Minimum Rating** based on the **StudentComptency** OR Hard-coded **Minimum Rating** value | Minimum Rating
Expand Down

0 comments on commit 7af85b0

Please sign in to comment.