View source for Help:RiskParameter

= Help:RiskParameter =

The &lt;riskparameter&gt; tag sets fixed values for one or more variables used in a risk calculation defined by a [[Help:RiskModel|RiskModel]] or [[Help:RiskDisplay|RiskDisplay]]. It is used on main pages alongside &lt;riskdisplay&gt; and &lt;dropdown&gt; tags to "hard-code" values specific to the page’s context.

== Syntax ==
The &lt;riskparameter&gt; tag uses attributes to specify variable names and their fixed values. Each attribute represents a variable-value pair (e.g., `miles_driven="14000"`).

Basic syntax:
<pre><nowiki>
<riskparameter miles_driven="14000" />
</nowiki></pre>
Multiple variables:
<pre><nowiki>
<riskparameter miles_driven="14000" exposure_factor="0.5" />
</nowiki></pre>

== Usage ==
# Use the &lt;riskparameter&gt; tag on a main page alongside &lt;riskdisplay&gt; and &lt;dropdown&gt; tags to set fixed values for variables used in a risk calculation.
# Ensure each attribute name matches a variable in a [[Help:RiskModel|RiskModel]] or [[Help:RiskDisplay|RiskDisplay]] calculation.
# Specify the fixed values as attribute values, such as numbers relevant to the page’s context (e.g., `14000` for typical annual miles driven in the US).

The &lt;riskparameter&gt; tag fixes the specified variables’ values for calculations on the page, overriding any default or dynamic values.

== Examples ==

=== Setting a Single Variable ===
Set the `miles_driven` variable to 14,000 for a driving risk page:
<pre><nowiki>
<riskparameter miles_driven="14000" />
</nowiki></pre>
This fixes `miles_driven` to 14,000 for any risk calculations on the page.

=== Setting Multiple Variables ===
Set `miles_driven` and `exposure_factor` variables:
<pre><nowiki>
<riskparameter miles_driven="14000" exposure_factor="0.5" />
</nowiki></pre>
This sets `miles_driven` to 14,000 and `exposure_factor` to 0.5 for use in calculations.

=== Combined with RiskDisplay and Dropdown ===
Use &lt;riskparameter&gt; with other tags on a driving risk page:
<pre><nowiki>
<riskparameter miles_driven="14000" exposure_factor="0.5" distraction_odds_ratio="1.2" />
<dropdown table="DrivingConditions" title="Select condition" label_column="Condition" />
<riskdisplay model="DrivingRisk" />
</nowiki></pre>
This sets `miles_driven`, `exposure_factor`, and `distraction_odds_ratio`, allows the user to select a condition via &lt;dropdown&gt;, and displays the result using the "DrivingRisk" &lt;riskmodel&gt;.

== Notes ==
* Each attribute name must match a variable used in a [[Help:RiskModel|RiskModel]] or [[Help:RiskDisplay|RiskDisplay]] calculation.
* Use &lt;riskparameter&gt; to set context-specific values, like average miles driven or fixed probability factors.
* The tag is typically used on main pages, while &lt;riskmodel&gt; definitions are often on "/Data" subpages.
* Multiple variables can be set in a single &lt;riskparameter&gt; tag using additional attributes.

== Troubleshooting ==
* **Calculation fails** – Ensure each attribute name matches a variable in the &lt;riskmodel&gt; or &lt;riskdisplay&gt; calculation.
* **No effect on calculation** – Verify that the &lt;riskparameter&gt; tag is on the same page as the &lt;riskdisplay&gt; or &lt;dropdown&gt; tags and that the attribute values are valid (e.g., numbers for numerical calculations).
* **Result not displayed** – Check that the &lt;riskdisplay&gt; tag references a valid &lt;riskmodel&gt; and includes the `{result}` placeholder if overriding text. See [[Help:RiskModel|RiskModel documentation]] for details.

For related features, see [[Help:RiskModel|RiskModel documentation]], [[Help:RiskDisplay|RiskDisplay documentation]], or [[Help:DropDown|DropDown documentation]].