Help:RiskModel: Difference between revisions
Created page with "= Help:RiskModel = The `<riskmodel>` tag defines a risk model on a wiki page, specifying a calculation and a unique name for use in other features, such as RiskDisplay. Variables in the calculation should match column names in a DataTable2 table. == Syntax == The `<riskmodel>` tag supports these attributes: * `name`: (Required) A unique name for the risk model on the page. * `calculation`: (Required) The mathematical expre..." |
Created by Grok, lightly edited. |
||
| Line 1: | Line 1: | ||
= Help:RiskModel = | = Help:RiskModel = | ||
The `<riskmodel>` tag defines a risk model on a wiki page, specifying a calculation and a unique name for use in other features, such as [[Help:RiskDisplay|RiskDisplay]]. Variables in the calculation | The `<riskmodel>` tag defines a risk model on a wiki page, specifying a calculation and a unique name for use in other features, such as [[Help:RiskDisplay|RiskDisplay]]. Variables in the calculation must match column names in a [[Extension:DataTable2|DataTable2]] table. The text inside the tag describes the risk and should include the `{result}` placeholder. | ||
== Syntax == | == Syntax == | ||
| Line 11: | Line 11: | ||
Basic syntax: | Basic syntax: | ||
<pre><nowiki> | <pre><nowiki> | ||
<riskmodel name="ModelName" calculation="base_probability * distraction_odds_ratio"> | <riskmodel name="ModelName" calculation="base_probability * distraction_odds_ratio">Your risk is about {result}%</riskmodel> | ||
</nowiki></pre> | </nowiki></pre> | ||
| Line 17: | Line 17: | ||
1. Use the `<riskmodel>` tag in your wikitext, specifying the `name` and `calculation` attributes. | 1. Use the `<riskmodel>` tag in your wikitext, specifying the `name` and `calculation` attributes. | ||
2. Ensure variable names in the `calculation` match column names in a DataTable2 table. | 2. Ensure variable names in the `calculation` match column names in a DataTable2 table. | ||
3. | 3. Include text between the opening and closing tags to describe the risk, using the `{result}` placeholder to show the calculated value. | ||
4. Reference the model by its `name` in other tags, like `<riskdisplay>`. | 4. Optionally, use wikitext markup or templates like `{{One_In_X|{result}}}`, which converts fractional probabilities (e.g., 0.1) into text like "1 in 10". | ||
5. Reference the model by its `name` in other tags, like `<riskdisplay>`. | |||
The `calculation` defines a mathematical expression using | The `calculation` defines a mathematical expression using DataTable2 column names, and the text with `{result}` describes the risk outcome for display. | ||
== Examples == | == Examples == | ||
=== Basic Risk Model === | === Basic Risk Model === | ||
Define a risk model named " | Define a risk model named "ColdRisk" with a calculation and result description: | ||
<pre><nowiki> | <pre><nowiki> | ||
<riskmodel name=" | <riskmodel name="ColdRisk" calculation="base_probability * exposure_factor">Your risk of catching a cold is about {result}%</riskmodel> | ||
</nowiki></pre> | </nowiki></pre> | ||
This creates a model called " | This creates a model called "ColdRisk" that multiplies `base_probability` and `exposure_factor`, displaying the result as a percentage. | ||
=== Risk Model with Template === | |||
Use the `{{One_In_X}}` template for human-friendly probability: | |||
<pre><nowiki> | |||
<riskmodel name="AccidentRisk" calculation="base_probability * distraction_odds_ratio">Your chance of an accident is {{One_In_X|{result}}}</riskmodel> | |||
</nowiki></pre> | |||
This model, "AccidentRisk", computes `base_probability * distraction_odds_ratio` and displays the result as "1 in X" (e.g., "1 in 10" for 0.1). | |||
=== Risk Model with Complex Calculation === | === Risk Model with Complex Calculation === | ||
Define a model with a more complex expression: | Define a model with a more complex expression and wikitext formatting: | ||
<pre><nowiki> | <pre><nowiki> | ||
<riskmodel name="RiskScore" calculation="base_probability * severity_weight + mitigation_factor / 2"> | <riskmodel name="RiskScore" calculation="base_probability * severity_weight + mitigation_factor / 2">The weighted risk score is '''{result}''' points</riskmodel> | ||
</nowiki></pre> | </nowiki></pre> | ||
This model, "RiskScore", computes `base_probability * severity_weight + mitigation_factor / 2`, | This model, "RiskScore", computes `base_probability * severity_weight + mitigation_factor / 2`, displaying the result in bold. | ||
== Notes == | == Notes == | ||
* The `name` attribute must be unique on the page to avoid conflicts. | * The `name` attribute must be unique on the page to avoid conflicts. | ||
* Variable names in the `calculation` must match column names in a DataTable2 table (e.g., `base_probability`, ` | * Variable names in the `calculation` must match column names in a DataTable2 table (e.g., `base_probability`, `exposure_factor`). Mismatched names will cause errors. | ||
* The ` | * The `{result}` placeholder must be included in the tag’s text to show the calculated value. | ||
* The text inside the tag can include wikitext markup (e.g., `'''bold'''`) or templates like `{{One_In_X|{result}}}` for formatting the result. | |||
* Risk models can be defined on the current page or a "Data/" subpage and referenced by name in other tags. | * Risk models can be defined on the current page or a "Data/" subpage and referenced by name in other tags. | ||
| Line 51: | Line 59: | ||
* **Model not found in `<riskdisplay>`** – Ensure the `name` matches exactly and the model is defined on the current page or a "Data/" subpage. | * **Model not found in `<riskdisplay>`** – Ensure the `name` matches exactly and the model is defined on the current page or a "Data/" subpage. | ||
* **Calculation fails** – Verify that all variable names in the `calculation` match column names in the associated DataTable2 table. | * **Calculation fails** – Verify that all variable names in the `calculation` match column names in the associated DataTable2 table. | ||
* **Result not displayed** – Ensure the `{result}` placeholder is included in the tag’s text and the calculation is valid. | |||
For related features, see [[Help:RiskDisplay|RiskDisplay documentation]] or [[Extension:DataTable2|DataTable2 documentation]]. | For related features, see [[Help:RiskDisplay|RiskDisplay documentation]] or [[Extension:DataTable2|DataTable2 documentation]]. | ||
Revision as of 15:38, 5 September 2025
Help:RiskModel
The `riskmodel: missing name attribute
</nowiki>
Usage
1. Use the `riskmodel: missing name attribute
</nowiki>
This creates a model called "ColdRisk" that multiplies `base_probability` and `exposure_factor`, displaying the result as a percentage.
Risk Model with Template
Use the `Error: Invalid probability` template for human-friendly probability:
<riskmodel name="AccidentRisk" calculation="base_probability * distraction_odds_ratio">Your chance of an accident is {{One_In_X|{result}}}</riskmodel>
This model, "AccidentRisk", computes `base_probability * distraction_odds_ratio` and displays the result as "1 in X" (e.g., "1 in 10" for 0.1).
Risk Model with Complex Calculation
Define a model with a more complex expression and wikitext formatting:
<riskmodel name="RiskScore" calculation="base_probability * severity_weight + mitigation_factor / 2">The weighted risk score is '''{result}''' points</riskmodel>
This model, "RiskScore", computes `base_probability * severity_weight + mitigation_factor / 2`, displaying the result in bold.
Notes
- The `name` attribute must be unique on the page to avoid conflicts.
- Variable names in the `calculation` must match column names in a DataTable2 table (e.g., `base_probability`, `exposure_factor`). Mismatched names will cause errors.
- The `{result}` placeholder must be included in the tag’s text to show the calculated value.
- The text inside the tag can include wikitext markup (e.g., `bold`) or templates like `Error: Invalid probability}` for formatting the result.
- Risk models can be defined on the current page or a "Data/" subpage and referenced by name in other tags.
Troubleshooting
- **Error: "riskmodel: missing name attribute"** – Include the `name` attribute in the tag.
- **Error: "riskmodel: missing calculation attribute"** – Include the `calculation` attribute.
- **Error: "riskmodel [expression]: [error message]"** – Check the `calculation` for syntax errors (e.g., unbalanced parentheses or invalid operators).
- **Model not found in `<riskdisplay>`** – Ensure the `name` matches exactly and the model is defined on the current page or a "Data/" subpage.
- **Calculation fails** – Verify that all variable names in the `calculation` match column names in the associated DataTable2 table.
- **Result not displayed** – Ensure the `{result}` placeholder is included in the tag’s text and the calculation is valid.
For related features, see RiskDisplay documentation or DataTable2 documentation.