Skip to content

Commit

Permalink
Adding help files to repo.
Browse files Browse the repository at this point in the history
  • Loading branch information
ptrow committed Nov 21, 2011
1 parent ef46e45 commit ecf68f6
Show file tree
Hide file tree
Showing 23 changed files with 1,406 additions and 0 deletions.
62 changes: 62 additions & 0 deletions doc/analysis.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
<link href="help.css"
type=text/css rel=stylesheet>
<h2>Example - Performing a Meta-Analysis</a></h2>
<p>This section presents an example of performing a meta-analysis using Open Meta-Analyst.</p>
<h3><a name="open_data">Opening the Data Set</h3>
To run the example, first open the
example data set:
<ol>
<li>Select <b>open</b> from the <b>File</b> menu.</li>
<li>Select the fiile BCG.oma.</li>
<li>Click <b>Open</b>.</li>
</ol>
<p>Open Meta-Analyst displays the data shown below.</p>
<img src="images/BCG.png"></img>
<h3><a name="run_analysis">Running the Analysis</a></h3>
<p>To perform a meta-analysis on the data, select <b>meta-analysis</b> from the
<b>Analysis</b> menu. This opens the Methods &amp; Parameters dialog, as shown
below.</p><img src="images/analysis_parameters_dialog.png"></img>
<p>You can select a method for the analysis in the analysis method field. The default method
is Binary Random, which uses the DerSimonian-Laird method to fit a random-effects model. The other options in the dialog are
described in
<a href="#analysis_options">Analysis Options</a>. </p>

<p>Click <b>OK</b> to
perform the analysis. The results are displayed in the results/analysis window.</p>

<h3><a name="summary">Viewing the Results</a></h3>

<p>The results of the meta-analyis consist of two parts:</p>
<ul>
<li>A Summary, which displays the overall numerical results of the meta-analysis.</li>
<li>A forest plot of the point estimates for each study and the overall results.</li>
</ul>

<img
src="images/ma_standard_summary.png"></img>
<img
src="images/ma_standard_forest_small.png"></img>&nbsp;</img>
<p>In the example above, the meta-analysis calculations are performed in logarithmic scale, so the model results
are displayed in standard and log scale. When calculations are performed in standary scale - for example, when the metric is risk difference - only one table is displayed.
</p>

<p>The forest plot shows the effect sizes and confidence intervals for each individual study, as well as the overall results.
The plot also displays the raw data for the studies and the overall results in three columns:</p>
<ul>
<li>ES(LL, UL) - Effect size (lower limit, upper limit)</li>
<li>Ev/Trt - Events in the treated group / Total number in the treated group</li>
<li>Ev/Ctrl - Events in the control group / Total number in the control group</li>
</ul>
<h3><a name="specify_metric">Changing the Metric for the Effect Size</a></h3>
<p> By default, the metric for the effect size is set to odds ratio (OR). To change
the metric:
<ol>
<li>Select <b>metric</b> in the <b>Analysis</b> menu.</li>
<li>Select <b>two-arm</b>. </li>
<li>Select a metric from the pop-up
menu, as shown below.</p><img
src="images/select_metric.png"></img>
<p><b>Note:</b> If you select <b>one-arm</b>, only the first two data columns (Tx An and Tx AN)
are included in the analysis. The Tx Bn and Tx BN columns are shaded grey.
<p>When you select a metric, the effect
sizes and confidence intervals are immediately updated. </p>
22 changes: 22 additions & 0 deletions doc/create_dataset.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<link href="help.css"
type=text/css rel=stylesheet>
<h2>Creating a New Data Set</a></h2>
<p>To create a new data set:</p>
<ol>
<li>Type the name of the data set:</li>
<img src="images/dataset_name.png"></img>
</li>
<li>Select the type of data you are working with. In this example, the data type is binary.</li>
<img src="images/dataset_type.jpg"</img>
</li>
<li> Select <b>create new</b>.
<p>This opens the dialog shown below.</p><img
src="images/outcome_dialog.png">
<li>In the dialog, type a name for the outcome of the test, and select the
type of outcome, <b>Binary</b> or <b>Continuous</b>, depending on the type of
data you are analyzing. Then click <b>OK</b>.</li>
</ol>
<p>The Open Meta-Analyst window now displays a row of fields where you can
enter data. For binary data, the row appears as shown
below.</p><img
src="images/added_binary_fields.png"></img>
57 changes: 57 additions & 0 deletions doc/css/help.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
body {
background: #ffffff;
font-family: Georgia, "Times New Roman",
Times, serif;
PADDING-RIGHT: 20px; PADDING-LEFT: 20px; PADDING-BOTTOM: 0px; MARGIN: 0px; COLOR: #564b47; PADDING-TOP: 0px; FONT-FAMILY: Verdana, Helvetica; BACKGROUND-COLOR: white;
}

p {
PADDING-RIGHT: 10px; PADDING-LEFT: 10px; PADDING-BOTTOM: 10px; MARGIN: 0px; PADDING-TOP: 10px;
width: 700px;
}

img {
PADDING-RIGHT: 10px; PADDING-LEFT: 10px; PADDING-BOTTOM: 20px; MARGIN: 0px; PADDING-TOP: 20px;
text-align: center;
}

li {
PADDING-BOTTOM: 10px
}

h1 {
font-size: 26px;
text-align: center;
color: white;
background-color: #3366FF;
padding-top: 5px;
padding-bottom: 5px;
padding-left: 0px;
padding-right: 0px;
margin:20px;
width: 1000px
}

h2 {
font-size:22px;
text-align: left;
color: #3366FF;
}
h3 {
font-size:18px;
color: #1c94c4;

}

h1, h2, h3, h3, h5, h6 {
font-familty: arial, Helvetica, Geneva, SunSans-Regular, sans-serif;
}

a{
text-decoration:none;
}

a:hover{
color:#ef8c08;
text-decoration:underline;
}
Loading

0 comments on commit ecf68f6

Please sign in to comment.