Merge pull request #77 from LorenFrankLab/metadata_improvements

Metadata improvements

Author: edeno

README.md

@@ -53,7 +53,7 @@ Developers should install from source.
 
     (*Note: By default, Trodes saves video-related files (`.h264`, `videoPositionTracking`, `cameraHWSync`) slightly different from this format as `{date}_{animal}_{epoch}_{tag}.{camera number}.{extension}`. This is accepted by this conversion package, and used to match camera to position tracking in epochs with mulitple cameras*)
 
-2. Create a metadata yaml file for each recording session. See this [example metadata yaml file](src/trodes_to_nwb/tests/test_data/20230622_sample_metadata.yml). We recommend using the [NWB YAML Creator](https://lorenfranklab.github.io/rec_to_nwb_yaml_creator/) to create the metadata yaml file in the correct format.
+2. Create a metadata yaml file for each recording session. We **HIGHLY** recommend using the [NWB YAML Creator](https://lorenfranklab.github.io/rec_to_nwb_yaml_creator/) to create the metadata yaml file to ensure compatability and correct format. You can also see this [example metadata yaml file](src/trodes_to_nwb/tests/test_data/20230622_sample_metadata.yml).
 
     The metadata yaml file should be named `{date}_{animal}.metadata.yml` where date is in the `YYYYMMDD` format and placed in the same directory as the `.rec` files.
 

src/trodes_to_nwb/tests/test_convert_yaml.py

@@ -6,13 +6,13 @@
 from hdmf.common.table import DynamicTable, VectorData
 from ndx_franklab_novela import CameraDevice, Probe, Shank, ShanksElectrode
 from pynwb.file import ProcessingModule, Subject
+
+from trodes_to_nwb import convert, convert_rec_header, convert_yaml
 from trodes_to_nwb.convert_position import add_associated_video_files
 from trodes_to_nwb.data_scanner import get_file_info
 from trodes_to_nwb.tests.test_convert_rec_header import default_test_xml_tree
 from trodes_to_nwb.tests.utils import data_path
 
-from trodes_to_nwb import convert, convert_rec_header, convert_yaml
-
 
 def test_initial_nwb_creation():
     metadata_path = data_path / "20230622_sample_metadata.yml"
@@ -73,7 +73,7 @@ def test_acq_device_creation():
     devices = nwb_file.devices
     assert len(devices) == 1
     name = f"dataacq_device0"
-    assert devices[name].system == "Main Control Unit"
+    assert devices[name].system == "SpikeGadgets"
     assert devices[name].amplifier == "Intan"
     assert devices[name].adc_circuit == "Intan"
 

src/trodes_to_nwb/tests/test_data/20230622_sample_metadata.yml

@@ -18,7 +18,7 @@ subject:
   weight: 100
 data_acq_device:
   - name: SpikeGadgets
-    system: Main Control Unit
+    system: SpikeGadgets
     amplifier: Intan
     adc_circuit: Intan
 cameras:

src/trodes_to_nwb/tests/test_data/20230622_sample_metadataProbeReconfig.yml

@@ -18,7 +18,7 @@ subject:
   weight: 100
 data_acq_device:
   - name: SpikeGadgets
-    system: Main Control Unit
+    system: SpikeGadgets
     amplifier: Intan
     adc_circuit: Intan
 cameras: