Template:Estimate/doc

From MOASSpedia
Jump to navigation Jump to search

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

Wikitext Output
{{Estimate}} ?
{{Estimate|4.2|3.5|5.7}} 4.2 (95% CI, 3.55.7)
{{Estimate|4.2|1.3|8.9|97.5}} 4.2 (97.5% CI, 1.38.9)
{{Estimate|-1.9|-7.4|-0.2|sep=to}} −1.9 (95% CI, −7.4 to −0.2)
{{Estimate|45|40|60|unit=%}} 45% (95% CI, 4060%)
{{Estimate|4.2|3.5|5.7|unit=kg}} 4.2 kg (95% CI, 3.55.7 kg)
{{Estimate|4.2|3.5|5.7|type=cri}} 4.2 (95% CrI, 3.55.7)
{{Estimate|4.2|3.5|5.7|mini=yes}} 4.2 (3.55.7)
{{Estimate|4.2|3.5|5.7|99|mini=yes}} 4.2 (3.55.7)
{{Estimate|4.2|3.5|5.7|mini=auto}} 4.2 (3.55.7)
{{Estimate|4.2|3.5|5.7|95|mini=auto}} 4.2 (3.55.7)
{{Estimate|4.2|3.5|5.7|99|mini=auto}} 4.2 (99% CI, 3.55.7)
{{Estimate|45|27|73|99|unit=%|type=cri|sep=to|mini=yes}} 45% (27 to 73%)

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Estimate

A template for styling individual table cells with standard contents and colors.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
estimate1

estimated value

Default
?
Numberrequired
lower2

lower bound

Default
?
Numbersuggested
higher3

upper bound

Default
?
Numbersuggested
level4

confidence or credibility level in percent

Default
95
Numbersuggested
separatorsep

interval separator, either 'dash' (for positive values) or 'to' (for negative or positive values)

Default
dash
Linesuggested
unitunit

unit of measure, such as kg, or sign, such as %

Default
Linesuggested
typetype

type of interval, either 'ci' (confidence interval) or 'cri' (credible interval)

Default
ci
Linesuggested
minimalmini

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)

Default
no
Lineoptional

See also

Notes