Version 0.7.2

CHANGELOG.rst

@@ -1,6 +1,17 @@
 Changes
 =======
 
+Version 0.7.2
+-------------
+
+**2018-07-17**
+
+* Improved conversion of EEG data to PTSA format (#107)
+* Fixed loading events for PS2 and PS4 (#110, #112)
+* Improved error message when trying to load EEG with an empty events DataFrame
+  (#114)
+
+
 Version 0.7.1
 -------------
 

README.rst

@@ -16,9 +16,6 @@ lab-specific file formats. Many of these readers have previously existed in
 other repositories, but are being migrated to a single repository since they
 are logically related.
 
-This is a work in progress and should be used with caution until the v1.0
-release as the API will likely undergo numerous changes up until that point.
-
 More information and usage examples are provided in the documentation_.
 
 .. _documentation: https://pennmem.github.io/cmlreaders/html/index.html

cmlreaders/__init__.py

@@ -7,5 +7,5 @@
 from .readers import *  # noqa
 from .cmlreader import CMLReader  # noqa
 
-__version__ = "0.7.1"
+__version__ = "0.7.2"
 version_info = namedtuple("VersionInfo", "major,minor,patch")(*__version__.split('.'))

cmlreaders/readers/eeg.py

@@ -255,12 +255,13 @@ class EEGReader(BaseCMLReader):
         >>> eeg = reader.load_eeg(epochs=epochs)
 
     Loading from specified epochs, when there are multiple files for the
-    session (units are relative to the start of each file):
+    session (units are relative to the start of each file)::
 
         >>> epochs = [(100,200,0), (100,200,1)]
         >>> eeg = reader.load_eeg(epochs=epochs)
 
-    Loading EEG from -100 ms to +100 ms relative to a set of events:
+    Loading EEG from -100 ms to +100 ms relative to a set of events::
+
         >>> events = reader.load("events")
         >>> eeg = reader.load_eeg(events, rel_start=-100, rel_stop=100)
 

docs/html/_modules/cmlreaders/cmlreader.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>cmlreaders.cmlreader &mdash; CML Data Readers 0.7.1 documentation</title>
+  <title>cmlreaders.cmlreader &mdash; CML Data Readers 0.7.2 documentation</title>
 
 
 
@@ -325,12 +325,16 @@ <h1>Source code for cmlreaders.cmlreader</h1><div class="highlight"><pre>
             <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s2">&quot;There is no reader to support the &quot;</span>
                                       <span class="s2">&quot;requested file type&quot;</span><span class="p">)</span>
 
-        <span class="c1"># By default we want task + math events when requesting events</span>
+        <span class="c1"># By default we want task + math events when requesting events so</span>
+        <span class="c1"># coerce to &quot;all_events&quot; unless we&#39;re looking at experiments that don&#39;t</span>
+        <span class="c1"># include these.</span>
         <span class="k">if</span> <span class="n">data_type</span> <span class="o">==</span> <span class="s2">&quot;events&quot;</span><span class="p">:</span>
-            <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;PS4&quot;</span><span class="p">):</span>
-                <span class="n">data_type</span> <span class="o">=</span> <span class="s2">&quot;all_events&quot;</span>
+            <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;PS2&quot;</span><span class="p">):</span>
+                <span class="n">data_type</span> <span class="o">=</span> <span class="s2">&quot;task_events&quot;</span>
+            <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">experiment</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;PS4&quot;</span><span class="p">):</span>
+                <span class="n">data_type</span> <span class="o">=</span> <span class="s2">&quot;task_events&quot;</span>
             <span class="k">else</span><span class="p">:</span>
-                <span class="n">data_type</span> <span class="o">=</span> <span class="s2">&quot;ps4_events&quot;</span>
+                <span class="n">data_type</span> <span class="o">=</span> <span class="s2">&quot;all_events&quot;</span>
 
         <span class="bp">cls</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">readers</span><span class="p">[</span><span class="n">data_type</span><span class="p">]</span>
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">protocol</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">cls</span><span class="o">.</span><span class="n">protocols</span><span class="p">:</span>
@@ -452,7 +456,7 @@ <h1>Source code for cmlreaders.cmlreader</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'0.7.1',
+            VERSION:'0.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/_modules/cmlreaders/convert.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>cmlreaders.convert &mdash; CML Data Readers 0.7.1 documentation</title>
+  <title>cmlreaders.convert &mdash; CML Data Readers 0.7.2 documentation</title>
 
 
 
@@ -286,7 +286,7 @@ <h1>Source code for cmlreaders.convert</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'0.7.1',
+            VERSION:'0.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',

docs/html/_modules/cmlreaders/path_finder.html

@@ -8,7 +8,7 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 
-  <title>cmlreaders.path_finder &mdash; CML Data Readers 0.7.1 documentation</title>
+  <title>cmlreaders.path_finder &mdash; CML Data Readers 0.7.2 documentation</title>
 
 
 
@@ -404,7 +404,7 @@ <h1>Source code for cmlreaders.path_finder</h1><div class="highlight"><pre>
     <script type="text/javascript">
         var DOCUMENTATION_OPTIONS = {
             URL_ROOT:'../../',
-            VERSION:'0.7.1',
+            VERSION:'0.7.2',
             LANGUAGE:'None',
             COLLAPSE_INDEX:false,
             FILE_SUFFIX:'.html',