Skip to content

Commit

Permalink
updated help file to include distribution choice
Browse files Browse the repository at this point in the history
  • Loading branch information
msrosenberg committed Sep 6, 2022
1 parent bb3723f commit 92b4cbc
Showing 1 changed file with 45 additions and 15 deletions.
60 changes: 45 additions & 15 deletions resources/metawin_help.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ <h1>Help Table of Contents</h1>
</ul>
</li>
<li><a href="#phylogeny_tab">Phylogeny Tab</a></li>
<li><a href="#analysis_options">Analysis Options</a></li>
<li><a href="#additional_options">Additional Options</a></li>
</ul>
</li>
Expand Down Expand Up @@ -353,21 +354,6 @@ <h4>Decimal Places</h4>
places used to display these values is automatically determined by the software based on the number of desired
replicates.</p>

<h4 id="alpha_level">Significance Level</h4>
<p>By default, significance levels for generating confidence intervals and certain types of tests are
based on a standard value of 5% (&alpha; = 0.05). This value can be changed by
choosing <span class="menu">Significance Level</span> from the
<span class="menu">Options&rarr;Output Options</span> menu or
<img class="toolbar-button" src="images/[email protected]"/> from the toolbar on the
left side of the Output Tab. Valid options are numbers between 0.01 and 1.0).
Note that changing this value will
only affect future output; vales already computed will not be changed. If you change the significance
level to use in the output, <span class="metawin">MetaWin</span> will attempt to remember this
choice the next time you run the program.</p>
<p>This choice also effects a few of the direct figures you can draw, such as
<a href="#forest_plot">Forest Plots</a>
and <a href="#normal_quantile_plot">Normal Quantile Plots</a>.</p>

<h4>Font</h4>
<p>You can change the font and it's properties used in the Output Tab by choosing
<span class="menu">Font</span> from the
Expand Down Expand Up @@ -470,6 +456,40 @@ <h2 id="phylogeny_tab">Phylogeny Tab</h2>
Meta-Analysis</a> option becomes available.
</p>

<h2 id="analysis_options">Analysis Options</h2>
<h4 id="alpha_level">Significance Level</h4>
<p>By default, significance levels for generating confidence intervals and certain types of tests are
based on a standard value of 5% (&alpha; = 0.05). This value can be changed by
choosing <span class="menu">Significance Level</span> from the
<span class="menu">Options&rarr;Analysis Options</span> menu or
<img class="toolbar-button" src="images/[email protected]"/> from the toolbar on the
left side of the Output Tab. Valid options are numbers between 0.01 and 1.0).
Note that changing this value will
only affect future output; vales already computed will not be changed. If you change the significance
level to use in the output, <span class="metawin">MetaWin</span> will attempt to remember this
choice the next time you run the program.</p>
<p>This choice also effects a few of the direct figures you can draw, such as
<a href="#forest_plot">Forest Plots</a>
and <a href="#normal_quantile_plot">Normal Quantile Plots</a>.</p>

<h4 id="ci_distribution">Confidence Interval Distribution</h4>
<p>When determining confidence intervals around means using standard distributions (rather than a
boostrap procedure), the traditional approach in meta-analysis has generally been to use a Normal
distribution. In earlier versions of <span class="metawin">MetaWin</span>, we used Student's <em>t</em>
distribution instead, because we thought it useful to account for the uncertainty in estimation due
to the small number of studies often found in meta-analyses. With this new version, the user can
specify which distribution they wish to use, with the Normal distribution set as default.
</p>
<p>To change the distribution, choose the item under the
<span class="menu">Options&rarr;Analysis Options</span> menu, which will toggle between the two
distributions. The current distribution is indicated by the icon to the left of the menu option
(either a <em><strong>Z</strong></em> or a <em><strong>t</strong></em>), as well as by the text
of the menu item which specifies the distributions being changed both "from" and "to".
<span class="metawin">MetaWin</span> will attempt to remember this choice the next time you run the
program.</p>
<p>The specified distribution is also listed as one of the user-specified parameters at the beginning of
analysis output.</p>

<h2 id="additional_options">Additional Options</h2>

<h3 id="updates">Check for Updates</h3>
Expand Down Expand Up @@ -889,6 +909,7 @@ <h3>Output</h3>
→ Fixed Effects Model
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution<br />
→ Use bootstrap for confidence intervals around means: 999 iterations<br />
→ Citations: Adams <em>et al.</em> (1997), Dixon (1993)
</p>
Expand Down Expand Up @@ -1119,6 +1140,9 @@ <h3>Output</h3>
→ Fixed Effects Model
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution
</p>
<p>
85 studies will be included in this analysis
</p>
<p>
Expand Down Expand Up @@ -1194,6 +1218,7 @@ <h3>Output</h3>
→ Fixed Effects Model
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution<br />
→ Use bootstrap for confidence intervals around means: 999 iterations<br/>
→ Citations: Adams <em>et al.</em> (1997), Dixon (1993)
</p>
Expand Down Expand Up @@ -1371,6 +1396,7 @@ <h3>Output</h3>
→ Fixed Effects Model
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution<br />
→ Use bootstrap for confidence intervals around means: 999 iterations<br/>
→ Citations: Adams <em>et al.</em> (1997), Dixon (1993)
</p>
Expand Down Expand Up @@ -1577,6 +1603,7 @@ <h3>Output</h3>
→ Fixed Effects Model
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution<br />
→ Use bootstrap for confidence intervals around means: 999 iterations<br/>
→ Citations: Adams <em>et al.</em> (1997), Dixon (1993)
</p>
Expand Down Expand Up @@ -1768,6 +1795,7 @@ <h3>Output</h3>
→ Citations: Adams <em>et al.</em> (1997), Dixon (1993)
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution<br />
→ Use randomization to test model structure: 999 iterations<br/>
→ Citation: Adams <em>et al.</em> (1997)
</p>
Expand Down Expand Up @@ -1987,6 +2015,7 @@ <h3>Output</h3>
→ Fixed Effects Model
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution<br />
→ Use bootstrap for confidence intervals around means: 999 iterations<br/>
→ Citations: Adams <em>et al.</em> (1997), Dixon (1993)
</p>
Expand Down Expand Up @@ -2216,6 +2245,7 @@ <h3>Output</h3>
→ Fixed Effects Model
</p>
<p>
→ Standard confidence intervals around means based on Normal distribution<br />
→ Use bootstrap for confidence intervals around means: 999 iterations<br/>
→ Citations: Adams <em>et al.</em> (1997), Dixon (1993)
</p>
Expand Down

0 comments on commit 92b4cbc

Please sign in to comment.