View source for Template:Estimate/doc

{{Documentation subpage}}
Formats an estimate associated with a [[confidence interval]] (CI) or a [[credible interval]] (CrI, sometimes notated as BCI) in the typical format of most scientific articles. It is also a more detailed representation of the [[uncertainty]] of a measurement. For other types of estimates or ranges, use [[Template:val]].

Includes a minimal format in which the level of confidence/credibility is omitted, but can be read using a tooltip. This brief format is sometimes useful for tables or to avoid repetition in prose where the confidence interval does not change. The minimal format can be used many times and is more readable, but some part of the text should explicitly state the level of confidence/credibility assumed, even when using the automatic minimum format (which assumes a typical level of 95%).

== Usage ==
{| class="wikitable"
|-
!Wikitext
!Output
|-
|<code><nowiki>{{Estimate}}</nowiki></code>
|{{Estimate}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7}}
|-
|<code><nowiki>{{Estimate|4.2|1.3|8.9|97.5}}</nowiki></code>
|{{Estimate|4.2|1.3|8.9|97.5}}
|-
|<code><nowiki>{{Estimate|-1.9|-7.4|-0.2|sep=to}}</nowiki></code>
|{{Estimate|-1.9|-7.4|-0.2|sep=to}}
|-
|<code><nowiki>{{Estimate|45|40|60|unit=%}}</nowiki></code>
|{{Estimate|45|40|60|unit=%}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7|unit=kg}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7|unit=kg}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7|type=cri}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7|type=cri}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7|mini=yes}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7|mini=yes}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7|99|mini=yes}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7|99|mini=yes}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7|mini=auto}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7|mini=auto}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7|95|mini=auto}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7|95|mini=auto}}
|-
|<code><nowiki>{{Estimate|4.2|3.5|5.7|99|mini=auto}}</nowiki></code>
|{{Estimate|4.2|3.5|5.7|99|mini=auto}}
|-
|<code><nowiki>{{Estimate|45|27|73|99|unit=%|type=cri|sep=to|mini=yes}}</nowiki></code>
|{{Estimate|45|27|73|99|unit=%|type=cri|sep=to|mini=yes}}
|}

== TemplateData ==
{{TemplateData header}}
<templatedata>{
  "description": "A template for styling individual table cells with standard contents and colors.",
  "params": {
    "1": {
      "label": "estimate",
      "description": "estimated value",
      "type": "number",
      "default": "?",
      "required": true
    },
    "2": {
      "label": "lower",
      "description": "lower bound",
      "type": "number",
      "default": "?",
      "required": false,
      "suggested": true
    },
    "3": {
      "label": "higher",
      "description": "upper bound",
      "type": "number",
      "default": "?",
      "required": false,
      "suggested": true
    },
    "4": {
      "label": "level",
      "description": "confidence or credibility level in percent",
      "type": "number",
      "default": "95",
      "required": false,
      "suggested": true
    },
    "sep": {
      "label": "separator",
      "description": "interval separator, either 'dash' (for positive values) or 'to' (for negative or positive values)",
      "type": "line",
      "default": "dash",
      "required": false,
      "suggested": true
    },
    "unit": {
      "label": "unit",
      "description": "unit of measure, such as kg, or sign, such as %",
      "type": "line",
      "default": "",
      "required": false,
      "suggested": true
    },
    "type": {
      "label": "type",
      "description": "type of interval, either 'ci' (confidence interval) or 'cri' (credible interval)",
      "type": "line",
      "default": "ci",
      "required": false,
      "suggested": true
    },
    "mini": {
      "label": "minimal",
      "description": "minimal format where the confidence or credibility level is placed in a tooltip, useful in tables to save space, either 'yes', 'no' or 'auto' (assumed 95% level, should be stated close by in prose)",
      "type": "line",
      "default": "no",
      "required": false,
      "suggested": false
    }
  },
  "format": "inline"
}</templatedata>

== See also ==
* [[Template:Val]]

== Notes ==
{{reflist}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Wikipedia formatting and function templates]]

}}</includeonly>