WIP: nwb line length, Readme mention of

Author: CBroz1

README.md

@@ -3,13 +3,19 @@
 + This repository features DataJoint pipeline design for extracellular array electrophysiology, 
 with Neuropixels probe and Kilosort spike sorting method. 
 
-+ The pipeline presented here is not a complete pipeline by itself, but rather a modular 
-design of tables and dependencies specific to the extracellular electrophysiology workflow. 
++ The pipeline presented here is not a complete pipeline by itself, but rather a modular
+design of tables and dependencies specific to the extracellular electrophysiology
+workflow
 
 + This modular pipeline element can be flexibly attached downstream 
 to any particular design of experiment session, thus assembling a fully functional 
 ephys pipeline.
 
++ This Element provides three schema options, selected via the DataJoint config file, with `dj.config['custom']['ephys_mode']`
+  + `acute` probe insertion, with curated clustering
+  + `chronic` probe insertion, with curated clustering
+  + `no-curation`, with kilosort triggered clustering
+
 + See the [Element Array Electrophysiology documentation](https://elements.datajoint.org/description/array_ephys/) for the background information and development timeline.
 
 + For more information on the DataJoint Elements project, please visit https://elements.datajoint.org.  This work is supported by the National Institutes of Health.

element_array_ephys/export/nwb/nwb.py

@@ -42,7 +42,8 @@ def __init__(self, lfp_electrodes_query, chunk_length: int = 10000):
         ----------
         lfp_electrodes_query: element_array_ephys.ephys.LFP.Electrode
         chunk_length: int, optional
-            Chunks are blocks of disk space where data are stored contiguously and compressed
+            Chunks are blocks of disk space where data are stored contiguously 
+            and compressed
         """
         self.lfp_electrodes_query = lfp_electrodes_query
         self.electrodes = self.lfp_electrodes_query.fetch("electrode")
@@ -305,8 +306,8 @@ def add_ephys_units_to_nwb(
 def get_electrodes_mapping(electrodes):
     """
     Create a mapping from the probe and electrode id to the row number of the electrodes
-    table. This is used in the construction of the DynamicTableRegion that indicates what rows of the electrodes
-    table correspond to the data in an ElectricalSeries.
+    table. This is used in the construction of the DynamicTableRegion that indicates
+    what rows of the electrodes table correspond to the data in an ElectricalSeries.
 
     Parameters
     ----------
@@ -359,18 +360,17 @@ def add_ephys_recording_to_nwb(
     end_frame: int = None,
 ):
     """
-    Read voltage data directly from source files and iteratively transfer them to the NWB file. Automatically
-    applies lossless compression to the data, so the final file might be smaller than the original, without
-    data loss. Currently supports Neuropixels data acquired with SpikeGLX or Open Ephys, and relies on SpikeInterface to read the data.
+    Read voltage data directly from source files and iteratively transfer them to the
+    NWB file. Automatically applies lossless compression to the data, so the final file
+    might be smaller than the original, without data loss. Currently supports
+    Neuropixels data acquired with SpikeGLX or Open Ephys, and relies on SpikeInterface
+    to read the data.
 
     source data -> acquisition["ElectricalSeries"]
 
     Parameters
     ----------
-    session_key: dict
-    ephys_root_data_dir: str
-    nwbfile: NWBFile
-    end_frame: int, optional
+    session_key: dict ephys_root_data_dir: str nwbfile: NWBFile end_frame: int, optional
         Used for small test conversions
     """
 
@@ -432,8 +432,12 @@ def add_ephys_lfp_from_dj_to_nwb(session_key: dict, nwbfile: pynwb.NWBFile):
     """
     Read LFP data from the data in element-aray-ephys
 
-    ephys.LFP.Electrode::lfp -> processing["ecephys"].lfp.electrical_series["ElectricalSeries{insertion_number}"].data
-    ephys.LFP::lfp_time_stamps -> processing["ecephys"].lfp.electrical_series["ElectricalSeries{insertion_number}"].timestamps
+    ephys.LFP.Electrode::lfp -> 
+        processing["ecephys"].lfp.electrical_series["ElectricalSeries{insertion_number}"
+                                                   ].data
+    ephys.LFP::lfp_time_stamps -> 
+        processing["ecephys"].lfp.electrical_series["ElectricalSeries{insertion_number}"
+                                                   ].timestamps
 
     Parameters
     ----------
@@ -478,7 +482,7 @@ def add_ephys_lfp_from_dj_to_nwb(session_key: dict, nwbfile: pynwb.NWBFile):
 def add_ephys_lfp_from_source_to_nwb(
     session_key: dict, ephys_root_data_dir, nwbfile: pynwb.NWBFile, end_frame=None):
     """
-    Read the LFP data directly from the source file. Currently, only works for SpikeGLX data.
+    Read the LFP data from the source file. Currently, only works for SpikeGLX data.
 
     ephys.EphysRecording::recording_datetime -> acquisition
 
@@ -517,7 +521,8 @@ def add_ephys_lfp_from_source_to_nwb(
             extractor = extractors.read_spikeglx(os.path.split(file_path)[0], "imec.lf")
         else:
             raise ValueError(
-                f"unsupported acq_software type: {ephys_recording_record['acq_software']}"
+                "unsupported acq_software type:" +
+                f"{ephys_recording_record['acq_software']}"
             )
 
         if end_frame is not None:
@@ -567,7 +572,7 @@ def ecephys_session_to_nwb(
     ----------
     session_key: dict
     raw: bool
-        Whether to include the raw data from source. SpikeGLX and OpenEphys are supported
+        Whether to include the raw data from source. SpikeGLX & OpenEphys are supported
     spikes: bool
         Whether to include CuratedClustering
     lfp:
@@ -576,13 +581,14 @@ def ecephys_session_to_nwb(
         False - do not convert LFP
     end_frame: int, optional
         Used to create small test conversions where large datasets are truncated.
-    lab_key, project_key, and protocol_key: dictionaries used to look up optional additional metadata
+    lab_key, project_key, and protocol_key: dictionaries to look up optional metadata
     nwbfile_kwargs: dict, optional
-        - If element-session is not being used, this argument is required and must be a dictionary containing
-          'session_description' (str), 'identifier' (str), and 'session_start_time' (datetime),
-          the minimal data for instantiating an NWBFile object.
-
-        - If element-session is being used, this argument can optionally be used to add over overwrite NWBFile fields.
+        - If element-session is not being used, this argument is required and must be a 
+          dictionary containing 'session_description' (str), 'identifier' (str), and 
+          'session_start_time' (datetime), the required minimal data for instantiating 
+          an NWBFile object.
+        - If element-session is being used, this argument can optionally be used to 
+          overwrite NWBFile fields.
     """
 
     session_to_nwb = getattr(ephys._linking_module, 'session_to_nwb', False)
@@ -611,7 +617,8 @@ def ecephys_session_to_nwb(
         add_ephys_lfp_from_dj_to_nwb(session_key, nwbfile)
 
     if lfp == "source":
-        add_ephys_lfp_from_source_to_nwb(session_key, ephys_root_data_dir=ephys_root_data_dir,
+        add_ephys_lfp_from_source_to_nwb(session_key, 
+                                         ephys_root_data_dir=ephys_root_data_dir,
                                          nwbfile=nwbfile, end_frame=end_frame)
 
     return nwbfile