filling out the format for now

JuliaStats · Mar 3, 2015 · b70fba0 · b70fba0
1 parent b76402f
commit b70fba0
Show file tree

Hide file tree

Showing 35 changed files with 1,053 additions and 236 deletions.
diff --git a/docs/_build/doctrees/apply.doctree b/docs/_build/doctrees/apply.doctree
diff --git a/docs/_build/doctrees/combine.doctree b/docs/_build/doctrees/combine.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/indexing.doctree b/docs/_build/doctrees/indexing.doctree
diff --git a/docs/_build/doctrees/readwrite.doctree b/docs/_build/doctrees/readwrite.doctree
diff --git a/docs/_build/doctrees/split.doctree b/docs/_build/doctrees/split.doctree
diff --git a/docs/_build/doctrees/split2.doctree b/docs/_build/doctrees/split2.doctree
diff --git a/docs/_build/doctrees/timearray.doctree b/docs/_build/doctrees/timearray.doctree
diff --git a/docs/_build/html/_sources/apply.txt b/docs/_build/html/_sources/apply.txt
@@ -1,9 +1,20 @@
 Apply methods
 =============
 
-TimeSeries is a registered package. To add it to your Julia packages, simply do the following in 
-REPL::
+lag
+---
 
-    Pkg.add("TimeSeries")
+lead
+----
 
-Throughout this tutorial, we'll be using historical financial data sets, which are made available in the
+percentchange
+------------
+
+moving
+-----
+
+upto
+---
+
+basecall
+-------
diff --git a/docs/_build/html/_sources/combine.txt b/docs/_build/html/_sources/combine.txt
@@ -1,9 +1,8 @@
 Combine methods
 ===============
 
-TimeSeries is a registered package. To add it to your Julia packages, simply do the following in 
-REPL::
+merge
+====
 
-    Pkg.add("TimeSeries")
-
-Throughout this tutorial, we'll be using historical financial data sets, which are made available in the
+collapse
+=======
diff --git a/docs/_build/html/_sources/index.txt b/docs/_build/html/_sources/index.txt
@@ -12,6 +12,7 @@ Contents
 
    getting_started
    timearray
+   indexing
    split
    apply
    combine

diff --git a/docs/_build/html/_sources/indexing.txt b/docs/_build/html/_sources/indexing.txt
@@ -0,0 +1,82 @@
+Array indexing
+==============
+
+Indexing out a time series is done with common bracketing semantics.
+
+Integers
+--------
+
++-----------+---------------------------------------+--------------------------------+ 
+| Example   | Description                           | Indexing value                 | 
++===========+=======================================+================================+ 
+| [1]       | First row of data only                | single integer                 |
++-----------+---------------------------------------+--------------------------------+ 
+| [1:3]     | First through third row only          | integer range                  |
++-----------+---------------------------------------+--------------------------------+ 
+| [1:3,8]   | First through third row and eight row | integer range & single inteter |
++-----------+---------------------------------------+--------------------------------+ 
+
+Examples in REPL::
+
+    julia> ohlc[1]
+    1x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-03
+
+                 Open    High    Low     Close
+    2000-01-03 | 104.88  112.5   101.69  111.94
+
+    julia> ohlc[1:2]
+    2x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-04
+
+                 Open    High    Low     Close
+    2000-01-03 | 104.88  112.5   101.69  111.94
+    2000-01-04 | 108.25  110.62  101.19  102.5
+
+
+Strings
+-------
+
++------------------+--------------------------------------+------------------+ 
+| Example          | Description                          | Indexing value   | 
++==================+======================================+==================+ 
+| ["Open"]         | The column named "Open"              | single string    |
++------------------+--------------------------------------+------------------+ 
+| ["Open","Close"] | The columns named "Open" and "Close" | multiple strings | 
++------------------+--------------------------------------+------------------+ 
+
+Examples in REPL::
+
+    julia> ohlc["Open", "Close"][1:2]
+    2x2 TimeArray{Float64,2} 2000-01-03 to 2000-01-04
+
+                 Open    Close
+    2000-01-03 | 104.88  111.94
+    2000-01-04 | 108.25  102.5
+
+    julia> ohlc["Low"][1:2]
+    2x1 TimeArray{Float64,1} 2000-01-03 to 2000-01-04
+
+                 Low
+    2000-01-03 | 101.69
+    2000-01-04 | 101.19
+
+Date and DateTime
+-----------------
+
++---------------------------------+--------------------------------------------+----------------+ 
+| Example                         | Description                                | Indexing value | 
++=================================+============================================+================+ 
+| [Date(2000,1,1)]                | The row containing Jan 1, 2000 timestamp   | single Date    |
++---------------------------------+--------------------------------------------+----------------+ 
+| [Date(2000,1,1),Date(2000,1,4)] | The rows containing Jan 1 & Jan 4, 2000    | multiple Dates |
++---------------------------------+--------------------------------------------+----------------+ 
+| [Date(2000,1,1):Date(2000,2,1)] | The rows between Jan 1, 2000 & Feb 1, 2000 | range of Date  |
++---------------------------------+--------------------------------------------+----------------+ 
+
+Examples in REPL::
+
+    julia> ohlc[[Date(2000,1,3), Date(2000,1,14)]]
+    2x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-14
+
+                 Open    High    Low     Close
+    2000-01-03 | 104.88  112.5   101.69  111.94
+    2000-01-14 | 100.0   102.25  99.38   100.44
diff --git a/docs/_build/html/_sources/readwrite.txt b/docs/_build/html/_sources/readwrite.txt
@@ -1,9 +1,5 @@
 Read/write methods
 ==================
 
-TimeSeries is a registered package. To add it to your Julia packages, simply do the following in 
-REPL::
-
-    Pkg.add("TimeSeries")
-
-Throughout this tutorial, we'll be using historical financial data sets, which are made available in the
+readtimearray
+-------------
diff --git a/docs/_build/html/_sources/split.txt b/docs/_build/html/_sources/split.txt
@@ -1,20 +1,36 @@
-Split methods
-=============
+Split methods: array indexing
+=============================
 
 Splitting up a time series is done by appending a bracketed expression after the object name. 
 
 Integers
 --------
 
-+-----------+---------------------------------------------+------------------+ 
-| Example   | Description                                 | Indexing value   | 
-+===========+=============================================+==================+ 
-| [1]       | First row of data only                      | single integer   |
-+-----------+---------------------------------------------+------------------+ 
-| [1:3]     | First through third row only                | integer range    |
-+-----------+---------------------------------------------+------------------+ 
-| [1:3,8]   | First through third row and eight row       | integer range,   |
-+-----------+---------------------------------------------+------------------+ 
++-----------+---------------------------------------+--------------------------------+ 
+| Example   | Description                           | Indexing value                 | 
++===========+=======================================+================================+ 
+| [1]       | First row of data only                | single integer                 |
++-----------+---------------------------------------+--------------------------------+ 
+| [1:3]     | First through third row only          | integer range                  |
++-----------+---------------------------------------+--------------------------------+ 
+| [1:3,8]   | First through third row and eight row | integer range & single inteter |
++-----------+---------------------------------------+--------------------------------+ 
+
+Examples in REPL::
+
+    julia> ohlc[1]
+    1x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-03
+
+                 Open    High    Low     Close
+    2000-01-03 | 104.88  112.5   101.69  111.94
+
+    julia> ohlc[1:2]
+    2x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-04
+
+                 Open    High    Low     Close
+    2000-01-03 | 104.88  112.5   101.69  111.94
+    2000-01-04 | 108.25  110.62  101.19  102.5
+
 
 Strings
 -------
@@ -27,6 +43,22 @@ Strings
 | ["Open","Close"] | The columns named "Open" and "Close" | multiple strings | 
 +------------------+--------------------------------------+------------------+ 
 
+Examples in REPL::
+
+    julia> ohlc["Open", "Close"][1:2]
+    2x2 TimeArray{Float64,2} 2000-01-03 to 2000-01-04
+
+                 Open    Close
+    2000-01-03 | 104.88  111.94
+    2000-01-04 | 108.25  102.5
+
+    julia> ohlc["Low"][1:2]
+    2x1 TimeArray{Float64,1} 2000-01-03 to 2000-01-04
+
+                 Low
+    2000-01-03 | 101.69
+    2000-01-04 | 101.19
+
 Date and DateTime
 -----------------
 
@@ -41,37 +73,10 @@ Date and DateTime
 +---------------------------------+--------------------------------------------+----------------+ 
 
 Examples in REPL::
-
-    julia> ohlc[1]
-    1x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-03
-
-                 Open    High    Low     Close
-    2000-01-03 | 104.88  112.5   101.69  111.94
-
-    julia> ohlc[1:2]
-    2x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-04
-
-                 Open    High    Low     Close
-    2000-01-03 | 104.88  112.5   101.69  111.94
-    2000-01-04 | 108.25  110.62  101.19  102.5
 
     julia> ohlc[[Date(2000,1,3), Date(2000,1,14)]]
     2x4 TimeArray{Float64,2} 2000-01-03 to 2000-01-14
 
                  Open    High    Low     Close
     2000-01-03 | 104.88  112.5   101.69  111.94
     2000-01-14 | 100.0   102.25  99.38   100.44
-
-    julia> ohlc["Low"][1:2]
-    2x1 TimeArray{Float64,1} 2000-01-03 to 2000-01-04
-
-                 Low
-    2000-01-03 | 101.69
-    2000-01-04 | 101.19
-
-    julia> ohlc["Open", "Close"][1:2]
-    2x2 TimeArray{Float64,2} 2000-01-03 to 2000-01-04
-
-                 Open    Close
-    2000-01-03 | 104.88  111.94
-    2000-01-04 | 108.25  102.5
diff --git a/docs/_build/html/_sources/split2.txt b/docs/_build/html/_sources/split2.txt
@@ -0,0 +1,19 @@
+Split methods: bracketing by time or boolean array
+=================================================
+
+Splitting up a time series is done by appending a bracketed expression after the object name. 
+
+by
+--
+
+from
+--
+
+to
+--
+
+findwhen
+--------
+
+findall
+-------
diff --git a/docs/_build/html/_sources/timearray.txt b/docs/_build/html/_sources/timearray.txt
@@ -1,9 +1,3 @@
 The TimeArray time series type
 ==============================
 
-TimeSeries is a registered package. To add it to your Julia packages, simply do the following in 
-REPL::
-
-    Pkg.add("TimeSeries")
-
-Throughout this tutorial, we'll be using historical financial data sets, which are made available in the
diff --git a/docs/_build/html/apply.html b/docs/_build/html/apply.html
@@ -32,7 +32,7 @@
 
     <link rel="top" title="timeseriesjl 0.2.2 documentation" href="index.html"/>
         <link rel="next" title="Combine methods" href="combine.html"/>
-        <link rel="prev" title="Split methods" href="split.html"/> 
+        <link rel="prev" title="Split methods: array indexing" href="split.html"/> 
 
 
   <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script>
@@ -66,10 +66,33 @@
             <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="timearray.html">The TimeArray time series type</a></li>
-<li class="toctree-l1"><a class="reference internal" href="split.html">Split methods</a></li>
-<li class="toctree-l1 current"><a class="current reference internal" href="">Apply methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="indexing.html">Array indexing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="indexing.html#integers">Integers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="indexing.html#strings">Strings</a></li>
+<li class="toctree-l2"><a class="reference internal" href="indexing.html#date-and-datetime">Date and DateTime</a></li>
+</ul>
+</li>
+<li class="toctree-l1"><a class="reference internal" href="split.html">Split methods: array indexing</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="split.html#integers">Integers</a></li>
+<li class="toctree-l2"><a class="reference internal" href="split.html#strings">Strings</a></li>
+<li class="toctree-l2"><a class="reference internal" href="split.html#date-and-datetime">Date and DateTime</a></li>
+</ul>
+</li>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Apply methods</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#lag">lag</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#lead">lead</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#percentchange">percentchange</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#moving">moving</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#basecall">basecall</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="combine.html">Combine methods</a></li>
-<li class="toctree-l1"><a class="reference internal" href="readwrite.html">Read/write methods</a></li>
+<li class="toctree-l1"><a class="reference internal" href="combine.html#merge">merge</a></li>
+<li class="toctree-l1"><a class="reference internal" href="combine.html#collapse">collapse</a></li>
+<li class="toctree-l1"><a class="reference internal" href="readwrite.html">Read/write methods</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="readwrite.html#readtimearray">readtimearray</a></li>
+</ul>
+</li>
 </ul>
 
 
@@ -106,12 +129,23 @@
 
   <div class="section" id="apply-methods">
 <h1>Apply methods<a class="headerlink" href="#apply-methods" title="Permalink to this headline">¶</a></h1>
-<p>TimeSeries is a registered package. To add it to your Julia packages, simply do the following in
-REPL:</p>
-<div class="highlight-julia"><div class="highlight"><pre><span class="n">Pkg</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s">&quot;TimeSeries&quot;</span><span class="p">)</span>
-</pre></div>
+<div class="section" id="lag">
+<h2>lag<a class="headerlink" href="#lag" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="lead">
+<h2>lead<a class="headerlink" href="#lead" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="percentchange">
+<h2>percentchange<a class="headerlink" href="#percentchange" title="Permalink to this headline">¶</a></h2>
+</div>
+<div class="section" id="moving">
+<h2>moving<a class="headerlink" href="#moving" title="Permalink to this headline">¶</a></h2>
+<p>upto
+&#8212;</p>
+</div>
+<div class="section" id="basecall">
+<h2>basecall<a class="headerlink" href="#basecall" title="Permalink to this headline">¶</a></h2>
 </div>
-<p>Throughout this tutorial, we&#8217;ll be using historical financial data sets, which are made available in the</p>
 </div>
 
 
@@ -123,7 +157,7 @@ <h1>Apply methods<a class="headerlink" href="#apply-methods" title="Permalink to
         <a href="combine.html" class="btn btn-neutral float-right" title="Combine methods">Next <span class="fa fa-arrow-circle-right"></span></a>
 
 
-        <a href="split.html" class="btn btn-neutral" title="Split methods"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+        <a href="split.html" class="btn btn-neutral" title="Split methods: array indexing"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 
     </div>