merge
authorDan Vanderkam <danvk@google.com>
Tue, 8 Dec 2009 20:34:52 +0000 (12:34 -0800)
committerDan Vanderkam <danvk@google.com>
Tue, 8 Dec 2009 20:34:52 +0000 (12:34 -0800)
1  2 
docs/index.html

diff --cc docs/index.html
@@@ -56,7 -56,7 +56,8 @@@
    <ul>
    <li><a href="#demo">Demo</a>
    <li><a href="#usage">Usage</a>
 +  <li><a href="#ie">IE Compatibility</a>
+   <li><a href="#baseball">Baseball chart</a>
    <li><a href="#stock">Stock chart</a>
    <li><a href="#options">Options Reference</a>
    <li><a href="#policy">Data Policy</a>
@@@ -354,34 -360,53 +361,81 @@@ new Dygraph
    <li>The error bars are partially transparent. This can be seen when they overlap one another.</li>
  </ul>
  
 +<a name="ie"><h2>Internet Explorer Compatibility</h2>
 +
 +<p>The dygraphs library relies heavily on HTML's &lt;canvas&gt; tag, which
 +Microsoft Internet Explorer does not support. Fortunately, some clever engineers
 +created the <a href="http://code.google.com/p/explorercanvas/">excanvas</a>
 +library, which imlements the &lt;canvas&gt; tag in IE using VML.</p>
 +
 +<p>You can add IE support to any page using dygraphs by including the following
 +in your page:</p>
 +
 +<pre>
 +&lt;head&gt;
 +&lt;!--[if IE]&gt;&lt;script src="excanvas.js"&gt;&lt;/script&gt;&lt;![endif]--&gt;
 +&lt;/head&gt;
 +</pre>
 +
 +<p>This works quite well in practice. Charts are responsive, even under VML
 +emulation.</p>
 +
 +<p>One common gotcha to look out for: make sure you don't have any trailing
 +commas in parameter lists, e.g.</p>
 +
 +<pre>new Dygraph(el, data, {
 +  showRoller:true,  // &lt;-- note trailing comma
 +})</pre>
 +
 +<p>Most browsers will ignore the trailing comma, but it will break under IE.</p>
 +
+ <a name="baseball"><h2>Charting Fractions</h2>
+ <p>Situations often arise where you want to plot fractions, e.g. the fraction of respondents in a poll who said they'd vote for candidate X or the number of hits divided by at bats (baseball's batting average). Fractions require special treatment for two main reasons:</p>
+ <ul>
+ <li>The average of <code>a1/b1</code> and <code>a2/b2</code> is
+ <code>(a1+a2)/(b1+b2)</code>, not <code>(a1/b1 + a2/b2)/2</code>.
+ <li>The normal approximation is not always applicable and more sophisticated
+ confidence intervals (e.g. the <a
+ href="http://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval">Wilson
+ confidence interval</a>) must be employed to avoid ratios that exceed 100% or
+ go below 0%.
+ </ul>
+ <p>Fortunately, dygraphs handles both of these for you! Here's a chart and the command that generated it:</p>
+ <div style="width:750px; text-align:center; font-weight: bold; font-size: 125%;">Batting Average for Ichiro Suzuki vs. Mariners (2004)</div>
+ <div id="baseballdiv" style="width:750px; height:300px;"></div>
+ <script type="text/javascript">
+ new Dygraph(document.getElementById("baseballdiv"),
+             "suzuki-mariners.txt", {
+               fractions: true,
+               errorBars: true,
+               showRoller: true,
+               rollPeriod: 15
+             });
+ </script>
+ <p>Command:</p>
+ <pre>
+ new Dygraph(
+   document.getElementById("baseballdiv"), "suzuki-mariners.txt",
+   {
+     fractions: true, errorBars: true,
+     showRoller: true, rollPeriod: 15
+   });
+ </pre>
+ <p>The <code>fractions</code> option indicates that the values in each column should be parsed as fractions (e.g. "1/2" instead of "0.5"). The <code>errorBars</code> option indicates that we'd like to see a confidence interval around each data point. By default, when <code>fractions</code> is set, you get a Wilson confidence interval. If you look carefully at the chart, you can see that the error bars are asymmetric.</p>
+ <p>A couple things to notice about this chart:</p>
+ <ul>
+ <li>The error bars for Ichiro's batting average are larger than for the Mariners', since he has far fewer at bats than his team.
+ <li>dygraphs makes it easy to see "batting average over the last 30 games". This is ordinarily quite difficult to compute. It makes it clear where the "hot" and "cold" part of Suzuki's season were.
+ <li>If you set the averaging period to something large, like 200, you'll see the team's and player's batting average through that game. The final number is the overall batting average for the season.
+ <li>Where the error bars do not overlap, we can say with 95% confidence that the series differ. There is a better than 95% chance that Ichiro was a better hitter than his team as a whole in 2004, the year he won the batting title.
+ </ul>
  <a name="stock"><h2>One last demo</h2>
  
  <p>This chart shows monthly closes of the Dow Jones Industrial Average, both in nominal and real (i.e. adjusted for inflation) dollars. The shaded areas show its monthly high and low. CPI values with a base from 1982-84 are used to adjust for inflation.</p>